org.llrp.ltk.generated.parameters
Class ROSpecEvent

java.lang.Object
  org.llrp.ltk.types.LLRPParameter
      org.llrp.ltk.types.TLVParameter
          org.llrp.ltk.generated.parameters.ROSpecEvent

public class ROSpecEvent
extends TLVParameter

This parameter carries the ROSpec event details. The EventType could be start or end of the ROSpec.ROSpecID: This is the ID of the ROSpec that started, ended or got preempted. See also LLRP Specification Section 13.2.6.4 and LLRP Specification Section 16.2.7.6.3 .

Field Summary

protected ROSpecEventType	eventType
protected UnsignedInteger	preemptingROSpecID
protected UnsignedInteger	rOSpecID
static SignedShort	TYPENUM

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

RESERVEDLENGTH, TYPENUMBERLENGTH

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

bitLength

Constructor Summary

ROSpecEvent()
empty constructor to create new parameter.

ROSpecEvent(org.jdom.Element element)
Constructor to create parameter from xml encoded parameter calls decodeXML to decode parameter.

ROSpecEvent(LLRPBitList list)
Constructor to create parameter from binary encoded parameter calls decodeBinary to decode parameter.

Method Summary

protected void	decodeBinarySpecific(LLRPBitList binary) decoding function to be implemented by each parameter
void	decodeXML(org.jdom.Element element) create objects from xml.
LLRPBitList	encodeBinarySpecific() protected method to force subclasses to implement their specific encoding
org.jdom.Content	encodeXML(java.lang.String name, org.jdom.Namespace ns) create xml representation of this parameter.
ROSpecEventType	getEventType() get eventType of type ROSpecEventType.
java.lang.String	getName() name of parameter (same as class name)
UnsignedInteger	getPreemptingROSpecID() get preemptingROSpecID of type UnsignedInteger.
UnsignedInteger	getROSpecID() get rOSpecID of type UnsignedInteger.
SignedShort	getTypeNum() type number uniquely identifies a parameter.
static java.lang.Integer	length() For TLV Parameter length can not be determined at compile time.
void	setEventType(ROSpecEventType eventType) set eventType of type ROSpecEventType .
void	setPreemptingROSpecID(UnsignedInteger preemptingROSpecID) set preemptingROSpecID of type UnsignedInteger .
void	setROSpecID(UnsignedInteger rOSpecID) set rOSpecID of type UnsignedInteger .
java.lang.String	toString() return string representation.

Methods inherited from class org.llrp.ltk.types.TLVParameter

decodeBinary, encodeBinary

Methods inherited from class org.llrp.ltk.types.LLRPParameter

getByteLength

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPENUM

public static final SignedShort TYPENUM

eventType

protected ROSpecEventType eventType

rOSpecID

protected UnsignedInteger rOSpecID

preemptingROSpecID

protected UnsignedInteger preemptingROSpecID

Constructor Detail

ROSpecEvent

public ROSpecEvent()

empty constructor to create new parameter.

ROSpecEvent

public ROSpecEvent(LLRPBitList list)

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

Parameters:

list - to be decoded

ROSpecEvent

public ROSpecEvent(org.jdom.Element element)
            throws InvalidLLRPMessageException

Constructor to create parameter from xml encoded parameter calls decodeXML to decode parameter.

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

Method Detail

encodeBinarySpecific

public LLRPBitList encodeBinarySpecific()

protected method to force subclasses to implement their specific encoding

Specified by:

encodeBinarySpecific in class TLVParameter

Returns:

LLRPBitList

encodeXML

public org.jdom.Content encodeXML(java.lang.String name,
                                  org.jdom.Namespace ns)

create xml representation of this parameter.

Specified by:

encodeXML in class LLRPParameter

Parameters:

name - of element

ns - Namespace of elements

decodeBinarySpecific

protected void decodeBinarySpecific(LLRPBitList binary)

decoding function to be implemented by each parameter

Specified by:

decodeBinarySpecific in class TLVParameter

Parameters:

binary - binary representation of the parameter

decodeXML

public void decodeXML(org.jdom.Element element)
               throws InvalidLLRPMessageException

create objects from xml.

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setEventType

public void setEventType(ROSpecEventType eventType)

set eventType of type ROSpecEventType .

Parameters:

eventType - to be set

setROSpecID

public void setROSpecID(UnsignedInteger rOSpecID)

set rOSpecID of type UnsignedInteger .

Parameters:

rOSpecID - to be set

setPreemptingROSpecID

public void setPreemptingROSpecID(UnsignedInteger preemptingROSpecID)

set preemptingROSpecID of type UnsignedInteger .

Parameters:

preemptingROSpecID - to be set

getEventType

public ROSpecEventType getEventType()

get eventType of type ROSpecEventType.

Returns:

ROSpecEventType

getROSpecID

public UnsignedInteger getROSpecID()

get rOSpecID of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getPreemptingROSpecID

public UnsignedInteger getPreemptingROSpecID()

get preemptingROSpecID of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

length

public static java.lang.Integer length()

For TLV Parameter length can not be determined at compile time. This method therefore always returns 0.

Returns:

Integer always zero

getTypeNum

public SignedShort getTypeNum()

type number uniquely identifies a parameter.

Specified by:

getTypeNum in class LLRPParameter

Returns:

typeNum

getName

public java.lang.String getName()

name of parameter (same as class name)

Specified by:

getName in class LLRPParameter

Returns:

String

toString

public java.lang.String toString()

return string representation. All field values but no parameters are included

Overrides:

toString in class java.lang.Object

Returns:

String