org.llrp.ltk.generated.messages
Class GET_ROSPECS_RESPONSE

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

public class GET_ROSPECS_RESPONSE
extends LLRPMessage

This is the response by the Reader to a GET_ROSPECS command. If there are no ROSpecs configured at the Reader, the response is just the LLRPStatus parameter with the success code. Else, a list of ROSpec parameter is returned by the Reader, along with the success code in the LLRPStatus parameter. See also LLRP Specification Section 10.1.14 and LLRP Specification Section 16.1.16

Field Summary

protected LLRPStatus	lLRPStatus
static java.lang.String	RESPONSETYPE
protected java.util.List<ROSpec>	rOSpecList
static SignedShort	TYPENUM

Fields inherited from class org.llrp.ltk.types.LLRPMessage

messageID, messageLength, messageReservedLength, MINHEADERLENGTH, reserved, RESERVEDLENGTH, TYPENUMBERLENGTH, version, VERSIONLENGTH

Constructor Summary

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

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

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

GET_ROSPECS_RESPONSE(LLRPBitList list)
Constructor to create message from binary encoded message calls decodeBinary to decode message.

Method Summary

void	addToROSpecList(ROSpec rOSpec) add element rOSpec of type ROSpec .
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.
LLRPStatus	getLLRPStatus() get lLRPStatus of type LLRPStatus .
java.lang.String	getName() name of message (same as class name)
java.lang.String	getResponseType() response message type awaited
java.util.List<ROSpec>	getROSpecList() get rOSpecList of type List <ROSpec> .
SignedShort	getTypeNum() return uniuque type number.
void	setLLRPStatus(LLRPStatus lLRPStatus) set lLRPStatus of type LLRPStatus.
void	setROSpecList(java.util.List<ROSpec> rOSpecList) set rOSpecList of type List <ROSpec>.

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

rOSpecList

protected java.util.List<ROSpec> rOSpecList

Constructor Detail

GET_ROSPECS_RESPONSE

public GET_ROSPECS_RESPONSE()

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

GET_ROSPECS_RESPONSE

public GET_ROSPECS_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_ROSPECS_RESPONSE

public GET_ROSPECS_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_ROSPECS_RESPONSE

public GET_ROSPECS_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

setROSpecList

public void setROSpecList(java.util.List<ROSpec> rOSpecList)

set rOSpecList of type List <ROSpec>.

Parameters:

rOSpecList - to be set

getLLRPStatus

public LLRPStatus getLLRPStatus()

get lLRPStatus of type LLRPStatus .

Returns:

LLRPStatus

getROSpecList

public java.util.List<ROSpec> getROSpecList()

get rOSpecList of type List <ROSpec> .

Returns:

List <ROSpec>

addToROSpecList

public void addToROSpecList(ROSpec rOSpec)

add element rOSpec of type ROSpec .

Parameters:

rOSpec - of type ROSpec

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