org.llrp.ltk.generated.messages
Class SET_READER_CONFIG

java.lang.Object
  extended by org.llrp.ltk.types.LLRPMessage
      extended by org.llrp.ltk.generated.messages.SET_READER_CONFIG

public class SET_READER_CONFIG
extends LLRPMessage

This command is issued by the Client to the Reader. This command sets the Reader configuration using the parameters specified in this command. Values passed by the SET_READER_CONFIG SHALL apply for the duration of the LLRP connection, or until the values are changed by additional SET_READER_CONFIG messages.For example, ROReportSpec defines the reporting of ROReport format and trigger for a ROSpec. ROReportSpec sent as part of SET_READER_CONFIG becomes the default ROReportSpec for the Reader. A ROReportSpec sent as part of ROSpec in the ADD_ROSPEC command overrides the default value for that ROSpec. However, in cases where there is no ROReportSpec specified in a ROSpec sent as part of ADD_ROSPEC, that particular ROSpec inherits the default ROReportSpec.The data field ResetToFactoryDefault informs the Reader to set all configurable values to factory defaults before applying the remaining parameters. See also LLRP Specification Section 12.1.3 and LLRP Specification Section 16.1.38


Field Summary
protected  AccessReportSpec accessReportSpec
           
protected  java.util.List<AntennaConfiguration> antennaConfigurationList
           
protected  java.util.List<AntennaProperties> antennaPropertiesList
           
protected  java.util.List<Custom> customList
           
protected  EventsAndReports eventsAndReports
           
protected  java.util.List<GPIPortCurrentState> gPIPortCurrentStateList
           
protected  java.util.List<GPOWriteData> gPOWriteDataList
           
protected  KeepaliveSpec keepaliveSpec
           
protected  ReaderEventNotificationSpec readerEventNotificationSpec
           
protected  BitList reserved0
           
protected  Bit resetToFactoryDefault
           
static java.lang.String RESPONSETYPE
           
protected  ROReportSpec rOReportSpec
           
static SignedShort TYPENUM
           
 
Fields inherited from class org.llrp.ltk.types.LLRPMessage
messageID, messageLength, messageReservedLength, MINHEADERLENGTH, reserved, RESERVEDLENGTH, TYPENUMBERLENGTH, version, VERSIONLENGTH
 
Constructor Summary
SET_READER_CONFIG()
          empty constructor to create new message with LLRP version set to 1.0 (0x1).
SET_READER_CONFIG(byte[] byteArray)
          Constructor to create message from binary encoded message calls decodeBinary to decode message.
SET_READER_CONFIG(org.jdom.Document document)
          Constructor to create message from xml encoded message calls decodeXML to decode message.
SET_READER_CONFIG(LLRPBitList list)
          Constructor to create message from binary encoded message calls decodeBinary to decode message.
 
Method Summary
 void addToAntennaConfigurationList(AntennaConfiguration antennaConfiguration)
          add element antennaConfiguration of type AntennaConfiguration .
 void addToAntennaPropertiesList(AntennaProperties antennaProperties)
          add element antennaProperties of type AntennaProperties .
 void addToCustomList(Custom custom)
          add element custom of type Custom .
 void addToGPIPortCurrentStateList(GPIPortCurrentState gPIPortCurrentState)
          add element gPIPortCurrentState of type GPIPortCurrentState .
 void addToGPOWriteDataList(GPOWriteData gPOWriteData)
          add element gPOWriteData of type GPOWriteData .
protected  void decodeBinarySpecific(LLRPBitList binary)
          to be implemented by specific message.
 void decodeXML(org.jdom.Document document)
          create objects from xml.
protected  LLRPBitList encodeBinarySpecific()
          encoding function - has to be implemented by each message.
 org.jdom.Document encodeXML()
          create xml representation of this parameter.
 AccessReportSpec getAccessReportSpec()
          get accessReportSpec of type AccessReportSpec .
 java.util.List<AntennaConfiguration> getAntennaConfigurationList()
          get antennaConfigurationList of type List <AntennaConfiguration> .
 java.util.List<AntennaProperties> getAntennaPropertiesList()
          get antennaPropertiesList of type List <AntennaProperties> .
 java.util.List<Custom> getCustomList()
          get customList of type List <Custom> .
 EventsAndReports getEventsAndReports()
          get eventsAndReports of type EventsAndReports .
 java.util.List<GPIPortCurrentState> getGPIPortCurrentStateList()
          get gPIPortCurrentStateList of type List <GPIPortCurrentState> .
 java.util.List<GPOWriteData> getGPOWriteDataList()
          get gPOWriteDataList of type List <GPOWriteData> .
 KeepaliveSpec getKeepaliveSpec()
          get keepaliveSpec of type KeepaliveSpec .
 java.lang.String getName()
          name of message (same as class name)
 ReaderEventNotificationSpec getReaderEventNotificationSpec()
          get readerEventNotificationSpec of type ReaderEventNotificationSpec .
 Bit getResetToFactoryDefault()
          get resetToFactoryDefault of type Bit.
 java.lang.String getResponseType()
          response message type awaited
 ROReportSpec getROReportSpec()
          get rOReportSpec of type ROReportSpec .
 SignedShort getTypeNum()
          return uniuque type number.
 void setAccessReportSpec(AccessReportSpec accessReportSpec)
          set accessReportSpec of type AccessReportSpec.
 void setAntennaConfigurationList(java.util.List<AntennaConfiguration> antennaConfigurationList)
          set antennaConfigurationList of type List <AntennaConfiguration>.
 void setAntennaPropertiesList(java.util.List<AntennaProperties> antennaPropertiesList)
          set antennaPropertiesList of type List <AntennaProperties>.
 void setCustomList(java.util.List<Custom> customList)
          set customList of type List <Custom>.
 void setEventsAndReports(EventsAndReports eventsAndReports)
          set eventsAndReports of type EventsAndReports.
 void setGPIPortCurrentStateList(java.util.List<GPIPortCurrentState> gPIPortCurrentStateList)
          set gPIPortCurrentStateList of type List <GPIPortCurrentState>.
 void setGPOWriteDataList(java.util.List<GPOWriteData> gPOWriteDataList)
          set gPOWriteDataList of type List <GPOWriteData>.
 void setKeepaliveSpec(KeepaliveSpec keepaliveSpec)
          set keepaliveSpec of type KeepaliveSpec.
 void setReaderEventNotificationSpec(ReaderEventNotificationSpec readerEventNotificationSpec)
          set readerEventNotificationSpec of type ReaderEventNotificationSpec.
 void setResetToFactoryDefault(Bit resetToFactoryDefault)
          set resetToFactoryDefault of type Bit .
 void setROReportSpec(ROReportSpec rOReportSpec)
          set rOReportSpec of type ROReportSpec.
 
Methods inherited from class org.llrp.ltk.types.LLRPMessage
decodeBinary, encodeBinary, getMessageID, getMessageLength, getVersion, isValidXMLMessage, setMessageID, setVersion, toBinaryString, toHexString, toXMLString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPENUM

public static final SignedShort TYPENUM

RESPONSETYPE

public static final java.lang.String RESPONSETYPE
See Also:
Constant Field Values

resetToFactoryDefault

protected Bit resetToFactoryDefault

reserved0

protected BitList reserved0

readerEventNotificationSpec

protected ReaderEventNotificationSpec readerEventNotificationSpec

antennaPropertiesList

protected java.util.List<AntennaProperties> antennaPropertiesList

antennaConfigurationList

protected java.util.List<AntennaConfiguration> antennaConfigurationList

rOReportSpec

protected ROReportSpec rOReportSpec

accessReportSpec

protected AccessReportSpec accessReportSpec

keepaliveSpec

protected KeepaliveSpec keepaliveSpec

gPOWriteDataList

protected java.util.List<GPOWriteData> gPOWriteDataList

gPIPortCurrentStateList

protected java.util.List<GPIPortCurrentState> gPIPortCurrentStateList

eventsAndReports

protected EventsAndReports eventsAndReports

customList

protected java.util.List<Custom> customList
Constructor Detail

SET_READER_CONFIG

public SET_READER_CONFIG()
empty constructor to create new message with LLRP version set to 1.0 (0x1).


SET_READER_CONFIG

public SET_READER_CONFIG(LLRPBitList list)
                  throws InvalidLLRPMessageException
Constructor to create message from binary encoded message calls decodeBinary to decode message.

Parameters:
list - to be decoded
Throws:
InvalidLLRPMessageException

SET_READER_CONFIG

public SET_READER_CONFIG(byte[] byteArray)
                  throws InvalidLLRPMessageException
Constructor to create message from binary encoded message calls decodeBinary to decode message.

Parameters:
byteArray - representing message
Throws:
InvalidLLRPMessageException

SET_READER_CONFIG

public SET_READER_CONFIG(org.jdom.Document document)
                  throws InvalidLLRPMessageException
Constructor to create message from xml encoded message calls decodeXML to decode message.

Parameters:
document - to be decoded
Throws:
InvalidLLRPMessageException
Method Detail

encodeBinarySpecific

protected LLRPBitList encodeBinarySpecific()
                                    throws InvalidLLRPMessageException
encoding function - has to be implemented by each message.

Specified by:
encodeBinarySpecific in class LLRPMessage
Returns:
LLRPBitList
Throws:
InvalidLLRPMessageException

encodeXML

public org.jdom.Document encodeXML()
                            throws InvalidLLRPMessageException
create xml representation of this parameter.

Specified by:
encodeXML in class LLRPMessage
Returns:
Dom Document
Throws:
InvalidLLRPMessageException

decodeBinarySpecific

protected void decodeBinarySpecific(LLRPBitList binary)
                             throws InvalidLLRPMessageException
to be implemented by specific message.

Specified by:
decodeBinarySpecific in class LLRPMessage
Parameters:
binary - without header
Throws:
InvalidLLRPMessageException

decodeXML

public void decodeXML(org.jdom.Document document)
               throws InvalidLLRPMessageException
create objects from xml.

Specified by:
decodeXML in class LLRPMessage
Parameters:
document - document as jdom document
Throws:
InvalidLLRPMessageException

setResetToFactoryDefault

public void setResetToFactoryDefault(Bit resetToFactoryDefault)
set resetToFactoryDefault of type Bit .

Parameters:
resetToFactoryDefault - to be set

setReaderEventNotificationSpec

public void setReaderEventNotificationSpec(ReaderEventNotificationSpec readerEventNotificationSpec)
set readerEventNotificationSpec of type ReaderEventNotificationSpec.

Parameters:
readerEventNotificationSpec - to be set

setAntennaPropertiesList

public void setAntennaPropertiesList(java.util.List<AntennaProperties> antennaPropertiesList)
set antennaPropertiesList of type List <AntennaProperties>.

Parameters:
antennaPropertiesList - to be set

setAntennaConfigurationList

public void setAntennaConfigurationList(java.util.List<AntennaConfiguration> antennaConfigurationList)
set antennaConfigurationList of type List <AntennaConfiguration>.

Parameters:
antennaConfigurationList - to be set

setROReportSpec

public void setROReportSpec(ROReportSpec rOReportSpec)
set rOReportSpec of type ROReportSpec.

Parameters:
rOReportSpec - to be set

setAccessReportSpec

public void setAccessReportSpec(AccessReportSpec accessReportSpec)
set accessReportSpec of type AccessReportSpec.

Parameters:
accessReportSpec - to be set

setKeepaliveSpec

public void setKeepaliveSpec(KeepaliveSpec keepaliveSpec)
set keepaliveSpec of type KeepaliveSpec.

Parameters:
keepaliveSpec - to be set

setGPOWriteDataList

public void setGPOWriteDataList(java.util.List<GPOWriteData> gPOWriteDataList)
set gPOWriteDataList of type List <GPOWriteData>.

Parameters:
gPOWriteDataList - to be set

setGPIPortCurrentStateList

public void setGPIPortCurrentStateList(java.util.List<GPIPortCurrentState> gPIPortCurrentStateList)
set gPIPortCurrentStateList of type List <GPIPortCurrentState>.

Parameters:
gPIPortCurrentStateList - to be set

setEventsAndReports

public void setEventsAndReports(EventsAndReports eventsAndReports)
set eventsAndReports of type EventsAndReports.

Parameters:
eventsAndReports - to be set

setCustomList

public void setCustomList(java.util.List<Custom> customList)
set customList of type List <Custom>.

Parameters:
customList - to be set

getResetToFactoryDefault

public Bit getResetToFactoryDefault()
get resetToFactoryDefault of type Bit.

Returns:
type Bit to be set

getReaderEventNotificationSpec

public ReaderEventNotificationSpec getReaderEventNotificationSpec()
get readerEventNotificationSpec of type ReaderEventNotificationSpec .

Returns:
ReaderEventNotificationSpec

getAntennaPropertiesList

public java.util.List<AntennaProperties> getAntennaPropertiesList()
get antennaPropertiesList of type List <AntennaProperties> .

Returns:
List <AntennaProperties>

getAntennaConfigurationList

public java.util.List<AntennaConfiguration> getAntennaConfigurationList()
get antennaConfigurationList of type List <AntennaConfiguration> .

Returns:
List <AntennaConfiguration>

getROReportSpec

public ROReportSpec getROReportSpec()
get rOReportSpec of type ROReportSpec .

Returns:
ROReportSpec

getAccessReportSpec

public AccessReportSpec getAccessReportSpec()
get accessReportSpec of type AccessReportSpec .

Returns:
AccessReportSpec

getKeepaliveSpec

public KeepaliveSpec getKeepaliveSpec()
get keepaliveSpec of type KeepaliveSpec .

Returns:
KeepaliveSpec

getGPOWriteDataList

public java.util.List<GPOWriteData> getGPOWriteDataList()
get gPOWriteDataList of type List <GPOWriteData> .

Returns:
List <GPOWriteData>

getGPIPortCurrentStateList

public java.util.List<GPIPortCurrentState> getGPIPortCurrentStateList()
get gPIPortCurrentStateList of type List <GPIPortCurrentState> .

Returns:
List <GPIPortCurrentState>

getEventsAndReports

public EventsAndReports getEventsAndReports()
get eventsAndReports of type EventsAndReports .

Returns:
EventsAndReports

getCustomList

public java.util.List<Custom> getCustomList()
get customList of type List <Custom> .

Returns:
List <Custom>

addToAntennaPropertiesList

public void addToAntennaPropertiesList(AntennaProperties antennaProperties)
add element antennaProperties of type AntennaProperties .

Parameters:
antennaProperties - of type AntennaProperties

addToAntennaConfigurationList

public void addToAntennaConfigurationList(AntennaConfiguration antennaConfiguration)
add element antennaConfiguration of type AntennaConfiguration .

Parameters:
antennaConfiguration - of type AntennaConfiguration

addToGPOWriteDataList

public void addToGPOWriteDataList(GPOWriteData gPOWriteData)
add element gPOWriteData of type GPOWriteData .

Parameters:
gPOWriteData - of type GPOWriteData

addToGPIPortCurrentStateList

public void addToGPIPortCurrentStateList(GPIPortCurrentState gPIPortCurrentState)
add element gPIPortCurrentState of type GPIPortCurrentState .

Parameters:
gPIPortCurrentState - of type GPIPortCurrentState

addToCustomList

public void addToCustomList(Custom custom)
add element custom of type Custom .

Parameters:
custom - of type Custom

getResponseType

public java.lang.String getResponseType()
Description copied from class: LLRPMessage
response message type awaited

Specified by:
getResponseType in class LLRPMessage
Returns:
String

getName

public java.lang.String getName()
Description copied from class: LLRPMessage
name of message (same as class name)

Specified by:
getName in class LLRPMessage
Returns:
String

getTypeNum

public SignedShort getTypeNum()
return uniuque type number.

Specified by:
getTypeNum in class LLRPMessage
Returns:
SignedShort holding unique type number


Copyright © 2007 ETH Zurich.