org.llrp.ltk.generated.parameters
Class ROSpecStopTrigger

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

public class ROSpecStopTrigger
extends TLVParameter

Describes the condition upon which the ROSpec will stop. See also LLRP Specification Section 10.2.1.1.2 and LLRP Specification Section 16.2.4.1.1.2 .

Field Summary

protected UnsignedInteger	durationTriggerValue
protected GPITriggerValue	gPITriggerValue
protected ROSpecStopTriggerType	rOSpecStopTriggerType
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

ROSpecStopTrigger()
empty constructor to create new parameter.

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

ROSpecStopTrigger(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.
UnsignedInteger	getDurationTriggerValue() get durationTriggerValue of type UnsignedInteger.
GPITriggerValue	getGPITriggerValue() get gPITriggerValue of type GPITriggerValue .
java.lang.String	getName() name of parameter (same as class name)
ROSpecStopTriggerType	getROSpecStopTriggerType() get rOSpecStopTriggerType of type ROSpecStopTriggerType.
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	setDurationTriggerValue(UnsignedInteger durationTriggerValue) set durationTriggerValue of type UnsignedInteger .
void	setGPITriggerValue(GPITriggerValue gPITriggerValue) set gPITriggerValue of type GPITriggerValue.
void	setROSpecStopTriggerType(ROSpecStopTriggerType rOSpecStopTriggerType) set rOSpecStopTriggerType of type ROSpecStopTriggerType .
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

rOSpecStopTriggerType

protected ROSpecStopTriggerType rOSpecStopTriggerType

durationTriggerValue

protected UnsignedInteger durationTriggerValue

gPITriggerValue

protected GPITriggerValue gPITriggerValue

Constructor Detail

ROSpecStopTrigger

public ROSpecStopTrigger()

empty constructor to create new parameter.

ROSpecStopTrigger

public ROSpecStopTrigger(LLRPBitList list)

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

Parameters:

list - to be decoded

ROSpecStopTrigger

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

setROSpecStopTriggerType

public void setROSpecStopTriggerType(ROSpecStopTriggerType rOSpecStopTriggerType)

set rOSpecStopTriggerType of type ROSpecStopTriggerType .

Parameters:

rOSpecStopTriggerType - to be set

setDurationTriggerValue

public void setDurationTriggerValue(UnsignedInteger durationTriggerValue)

set durationTriggerValue of type UnsignedInteger .

Parameters:

durationTriggerValue - to be set

setGPITriggerValue

public void setGPITriggerValue(GPITriggerValue gPITriggerValue)

set gPITriggerValue of type GPITriggerValue.

Parameters:

gPITriggerValue - to be set

getROSpecStopTriggerType

public ROSpecStopTriggerType getROSpecStopTriggerType()

get rOSpecStopTriggerType of type ROSpecStopTriggerType.

Returns:

ROSpecStopTriggerType

getDurationTriggerValue

public UnsignedInteger getDurationTriggerValue()

get durationTriggerValue of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getGPITriggerValue

public GPITriggerValue getGPITriggerValue()

get gPITriggerValue of type GPITriggerValue .

Returns:

GPITriggerValue

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