org.llrp.ltk.generated.parameters
Class TagObservationTrigger

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

public class TagObservationTrigger
extends TLVParameter

Describes the boundary (stop) condition that is based on tag observations. See also LLRP Specification Section 10.2.2.1.1 and LLRP Specification Section 16.2.4.2.1.1 .

Field Summary

protected UnsignedShort	numberOfAttempts
protected UnsignedShort	numberOfTags
protected BitList	reserved0
protected UnsignedShort	t
protected UnsignedInteger	timeout
protected TagObservationTriggerType	triggerType
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

TagObservationTrigger()
empty constructor to create new parameter.

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

TagObservationTrigger(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.
java.lang.String	getName() name of parameter (same as class name)
UnsignedShort	getNumberOfAttempts() get numberOfAttempts of type UnsignedShort.
UnsignedShort	getNumberOfTags() get numberOfTags of type UnsignedShort.
UnsignedShort	getT() get t of type UnsignedShort.
UnsignedInteger	getTimeout() get timeout of type UnsignedInteger.
TagObservationTriggerType	getTriggerType() get triggerType of type TagObservationTriggerType.
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	setNumberOfAttempts(UnsignedShort numberOfAttempts) set numberOfAttempts of type UnsignedShort .
void	setNumberOfTags(UnsignedShort numberOfTags) set numberOfTags of type UnsignedShort .
void	setT(UnsignedShort t) set t of type UnsignedShort .
void	setTimeout(UnsignedInteger timeout) set timeout of type UnsignedInteger .
void	setTriggerType(TagObservationTriggerType triggerType) set triggerType of type TagObservationTriggerType .
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

triggerType

protected TagObservationTriggerType triggerType

reserved0

protected BitList reserved0

numberOfTags

protected UnsignedShort numberOfTags

numberOfAttempts

protected UnsignedShort numberOfAttempts

t

protected UnsignedShort t

timeout

protected UnsignedInteger timeout

Constructor Detail

TagObservationTrigger

public TagObservationTrigger()

empty constructor to create new parameter.

TagObservationTrigger

public TagObservationTrigger(LLRPBitList list)

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

Parameters:

list - to be decoded

TagObservationTrigger

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

setTriggerType

public void setTriggerType(TagObservationTriggerType triggerType)

set triggerType of type TagObservationTriggerType .

Parameters:

triggerType - to be set

setNumberOfTags

public void setNumberOfTags(UnsignedShort numberOfTags)

set numberOfTags of type UnsignedShort .

Parameters:

numberOfTags - to be set

setNumberOfAttempts

public void setNumberOfAttempts(UnsignedShort numberOfAttempts)

set numberOfAttempts of type UnsignedShort .

Parameters:

numberOfAttempts - to be set

setT

public void setT(UnsignedShort t)

set t of type UnsignedShort .

Parameters:

t - to be set

setTimeout

public void setTimeout(UnsignedInteger timeout)

set timeout of type UnsignedInteger .

Parameters:

timeout - to be set

getTriggerType

public TagObservationTriggerType getTriggerType()

get triggerType of type TagObservationTriggerType.

Returns:

TagObservationTriggerType

getNumberOfTags

public UnsignedShort getNumberOfTags()

get numberOfTags of type UnsignedShort.

Returns:

type UnsignedShort to be set

getNumberOfAttempts

public UnsignedShort getNumberOfAttempts()

get numberOfAttempts of type UnsignedShort.

Returns:

type UnsignedShort to be set

getT

public UnsignedShort getT()

get t of type UnsignedShort.

Returns:

type UnsignedShort to be set

getTimeout

public UnsignedInteger getTimeout()

get timeout 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