org.llrp.ltk.generated.messages
Class START_ROSPEC_RESPONSE

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

public class START_ROSPEC_RESPONSE
extends LLRPMessage

This is the response by the Reader to a START_ROSPEC command. If there was a ROSpec corresponding to the ROSpecID in the enabled state, and the Reader was able to start executing that ROSpec, then the success code is returned in the LLRPStatus parameter. If there is an error, the appropriate error code is returned in the LLRPStatus parameter. See also LLRP Specification Section 10.1.6 and LLRP Specification Section 16.1.8


Field Summary
protected  LLRPStatus lLRPStatus
           
static java.lang.String RESPONSETYPE
           
static SignedShort TYPENUM
           
 
Fields inherited from class org.llrp.ltk.types.LLRPMessage
messageID, messageLength, messageReservedLength, MINHEADERLENGTH, reserved, RESERVEDLENGTH, TYPENUMBERLENGTH, version, VERSIONLENGTH
 
Constructor Summary
START_ROSPEC_RESPONSE()
          empty constructor to create new message with LLRP version set to 1.0 (0x1).
START_ROSPEC_RESPONSE(byte[] byteArray)
          Constructor to create message from binary encoded message calls decodeBinary to decode message.
START_ROSPEC_RESPONSE(org.jdom.Document document)
          Constructor to create message from xml encoded message calls decodeXML to decode message.
START_ROSPEC_RESPONSE(LLRPBitList list)
          Constructor to create message from binary encoded message calls decodeBinary to decode message.
 
Method Summary
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
 SignedShort getTypeNum()
          return uniuque type number.
 void setLLRPStatus(LLRPStatus lLRPStatus)
          set lLRPStatus of type LLRPStatus.
 
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
Constructor Detail

START_ROSPEC_RESPONSE

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


START_ROSPEC_RESPONSE

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

START_ROSPEC_RESPONSE

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

Parameters:
byteArray - representing message
Throws:
InvalidLLRPMessageException

START_ROSPEC_RESPONSE

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

getLLRPStatus

public LLRPStatus getLLRPStatus()
get lLRPStatus of type LLRPStatus .

Returns:
LLRPStatus

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.