org.llrp.ltk.generated.messages
Class GET_READER_CONFIG_RESPONSE

java.lang.Object
  org.llrp.ltk.types.LLRPMessage
      org.llrp.ltk.generated.messages.GET_READER_CONFIG_RESPONSE

public class GET_READER_CONFIG_RESPONSE
extends LLRPMessage

This is the response by the Reader to the GET_READER_CONFIG message. The response is the LLRPStatus Parameter and the list of configuration parameters based on the RequestedData in GET_READER_CONFIG. If the GET_READER_CONFIG message did not have any errors, the success code is returned in the LLRPStatus parameter, and in addition the requested configuration parameters are returned. If there is an error, the appropriate error code is returned in the LLRPStatus parameter. The response contains at most one instance of each configuration parameter except for two cases, which are as follows:If RequestedData is 0, 2 or 3, and AntennaID is set to 0 in the GET_READER_CONFIG message, the Reader SHALL return one instance of AntennaProperties Parameter or AntennaConfiguration Parameter per requested antenna.If RequestedData is 0 or 9 (10), and GPIPortNum (GPOPortNum) is set to 0 in the GET_READER_CONFIG message, and, if the Reader supports GPI (GPO), the Reader SHALL return one instance of GPIPortCurrentState (GPOWriteData) Parameter per requested GPI Port (GPO Port). See also LLRP Specification Section 12.1.2 and LLRP Specification Section 16.1.37

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 Identification	identification
protected KeepaliveSpec	keepaliveSpec
protected LLRPConfigurationStateValue	lLRPConfigurationStateValue
protected LLRPStatus	lLRPStatus
protected ReaderEventNotificationSpec	readerEventNotificationSpec
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

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

GET_READER_CONFIG_RESPONSE(byte[] byteArray)
Constructor to create message from binary encoded message calls decodeBinary to decode message.

GET_READER_CONFIG_RESPONSE(org.jdom.Document document)
Constructor to create message from xml encoded message calls decodeXML to decode message.

GET_READER_CONFIG_RESPONSE(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> .
Identification	getIdentification() get identification of type Identification .
KeepaliveSpec	getKeepaliveSpec() get keepaliveSpec of type KeepaliveSpec .
LLRPConfigurationStateValue	getLLRPConfigurationStateValue() get lLRPConfigurationStateValue of type LLRPConfigurationStateValue .
LLRPStatus	getLLRPStatus() get lLRPStatus of type LLRPStatus .
java.lang.String	getName() name of message (same as class name)
ReaderEventNotificationSpec	getReaderEventNotificationSpec() get readerEventNotificationSpec of type ReaderEventNotificationSpec .
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	setIdentification(Identification identification) set identification of type Identification.
void	setKeepaliveSpec(KeepaliveSpec keepaliveSpec) set keepaliveSpec of type KeepaliveSpec.
void	setLLRPConfigurationStateValue(LLRPConfigurationStateValue lLRPConfigurationStateValue) set lLRPConfigurationStateValue of type LLRPConfigurationStateValue.
void	setLLRPStatus(LLRPStatus lLRPStatus) set lLRPStatus of type LLRPStatus.
void	setReaderEventNotificationSpec(ReaderEventNotificationSpec readerEventNotificationSpec) set readerEventNotificationSpec of type ReaderEventNotificationSpec.
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

lLRPStatus

protected LLRPStatus lLRPStatus

identification

protected Identification identification

antennaPropertiesList

protected java.util.List<AntennaProperties> antennaPropertiesList

antennaConfigurationList

protected java.util.List<AntennaConfiguration> antennaConfigurationList

readerEventNotificationSpec

protected ReaderEventNotificationSpec readerEventNotificationSpec

rOReportSpec

protected ROReportSpec rOReportSpec

accessReportSpec

protected AccessReportSpec accessReportSpec

lLRPConfigurationStateValue

protected LLRPConfigurationStateValue lLRPConfigurationStateValue

keepaliveSpec

protected KeepaliveSpec keepaliveSpec

gPIPortCurrentStateList

protected java.util.List<GPIPortCurrentState> gPIPortCurrentStateList

gPOWriteDataList

protected java.util.List<GPOWriteData> gPOWriteDataList

eventsAndReports

protected EventsAndReports eventsAndReports

customList

protected java.util.List<Custom> customList

Constructor Detail

GET_READER_CONFIG_RESPONSE

public GET_READER_CONFIG_RESPONSE()

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

GET_READER_CONFIG_RESPONSE

public GET_READER_CONFIG_RESPONSE(LLRPBitList list)
                           throws InvalidLLRPMessageException

Constructor to create message from binary encoded message calls decodeBinary to decode message.

Parameters:

list - to be decoded

Throws:

InvalidLLRPMessageException

GET_READER_CONFIG_RESPONSE

public GET_READER_CONFIG_RESPONSE(byte[] byteArray)
                           throws InvalidLLRPMessageException

Constructor to create message from binary encoded message calls decodeBinary to decode message.

Parameters:

byteArray - representing message

Throws:

InvalidLLRPMessageException

GET_READER_CONFIG_RESPONSE

public GET_READER_CONFIG_RESPONSE(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

setLLRPStatus

public void setLLRPStatus(LLRPStatus lLRPStatus)

set lLRPStatus of type LLRPStatus.

Parameters:

lLRPStatus - to be set

setIdentification

public void setIdentification(Identification identification)

set identification of type Identification.

Parameters:

identification - 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

setReaderEventNotificationSpec

public void setReaderEventNotificationSpec(ReaderEventNotificationSpec readerEventNotificationSpec)

set readerEventNotificationSpec of type ReaderEventNotificationSpec.

Parameters:

readerEventNotificationSpec - 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

setLLRPConfigurationStateValue

public void setLLRPConfigurationStateValue(LLRPConfigurationStateValue lLRPConfigurationStateValue)

set lLRPConfigurationStateValue of type LLRPConfigurationStateValue.

Parameters:

lLRPConfigurationStateValue - to be set

setKeepaliveSpec

public void setKeepaliveSpec(KeepaliveSpec keepaliveSpec)

set keepaliveSpec of type KeepaliveSpec.

Parameters:

keepaliveSpec - to be set

setGPIPortCurrentStateList

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

set gPIPortCurrentStateList of type List <GPIPortCurrentState>.

Parameters:

gPIPortCurrentStateList - to be set

setGPOWriteDataList

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

set gPOWriteDataList of type List <GPOWriteData>.

Parameters:

gPOWriteDataList - 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

getLLRPStatus

public LLRPStatus getLLRPStatus()

get lLRPStatus of type LLRPStatus .

Returns:

LLRPStatus

getIdentification

public Identification getIdentification()

get identification of type Identification .

Returns:

Identification

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>

getReaderEventNotificationSpec

public ReaderEventNotificationSpec getReaderEventNotificationSpec()

get readerEventNotificationSpec of type ReaderEventNotificationSpec .

Returns:

ReaderEventNotificationSpec

getROReportSpec

public ROReportSpec getROReportSpec()

get rOReportSpec of type ROReportSpec .

Returns:

ROReportSpec

getAccessReportSpec

public AccessReportSpec getAccessReportSpec()

get accessReportSpec of type AccessReportSpec .

Returns:

AccessReportSpec

getLLRPConfigurationStateValue

public LLRPConfigurationStateValue getLLRPConfigurationStateValue()

get lLRPConfigurationStateValue of type LLRPConfigurationStateValue .

Returns:

LLRPConfigurationStateValue

getKeepaliveSpec

public KeepaliveSpec getKeepaliveSpec()

get keepaliveSpec of type KeepaliveSpec .

Returns:

KeepaliveSpec

getGPIPortCurrentStateList

public java.util.List<GPIPortCurrentState> getGPIPortCurrentStateList()

get gPIPortCurrentStateList of type List <GPIPortCurrentState> .

Returns:

List <GPIPortCurrentState>

getGPOWriteDataList

public java.util.List<GPOWriteData> getGPOWriteDataList()

get gPOWriteDataList of type List <GPOWriteData> .

Returns:

List <GPOWriteData>

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

addToGPIPortCurrentStateList

public void addToGPIPortCurrentStateList(GPIPortCurrentState gPIPortCurrentState)

add element gPIPortCurrentState of type GPIPortCurrentState .

Parameters:

gPIPortCurrentState - of type GPIPortCurrentState

addToGPOWriteDataList

public void addToGPOWriteDataList(GPOWriteData gPOWriteData)

add element gPOWriteData of type GPOWriteData .

Parameters:

gPOWriteData - of type GPOWriteData

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