org.llrp.ltk.generated.messages
Class STOP_ROSPEC

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

public class STOP_ROSPEC
extends LLRPMessage

This message is issued by the Client to the Reader. Upon receiving the message, the Reader stops the execution of the ROSpec corresponding to the ROSpecID passed in this message. STOP_ROSPEC overrides all other priorities and stops the execution. This basically moves the ROSpec's state to Inactive. This message does not the delete the ROSpec.ROSpecID: Zero is disallowed. See also LLRP Specification Section 10.1.7 and LLRP Specification Section 16.1.9

Field Summary

static java.lang.String	RESPONSETYPE
protected UnsignedInteger	rOSpecID
static SignedShort	TYPENUM

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

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

Constructor Summary

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

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

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

STOP_ROSPEC(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.
java.lang.String	getName() name of message (same as class name)
java.lang.String	getResponseType() response message type awaited
UnsignedInteger	getROSpecID() get rOSpecID of type UnsignedInteger.
SignedShort	getTypeNum() return uniuque type number.
void	setROSpecID(UnsignedInteger rOSpecID) set rOSpecID of type UnsignedInteger .

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

rOSpecID

protected UnsignedInteger rOSpecID

Constructor Detail

STOP_ROSPEC

public STOP_ROSPEC()

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

STOP_ROSPEC

public STOP_ROSPEC(LLRPBitList list)
            throws InvalidLLRPMessageException

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

Parameters:

list - to be decoded

Throws:

InvalidLLRPMessageException

STOP_ROSPEC

public STOP_ROSPEC(byte[] byteArray)
            throws InvalidLLRPMessageException

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

Parameters:

byteArray - representing message

Throws:

InvalidLLRPMessageException

STOP_ROSPEC

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

setROSpecID

public void setROSpecID(UnsignedInteger rOSpecID)

set rOSpecID of type UnsignedInteger .

Parameters:

rOSpecID - to be set

getROSpecID

public UnsignedInteger getROSpecID()

get rOSpecID of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

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