org.llrp.ltk.generated.parameters
Class PeriodicTriggerValue

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

public class PeriodicTriggerValue
extends TLVParameter

Periodic trigger is specified using UTC time, offset and period.For one-shot inventory, period is set to 0, and for periodic inventory operation period > 0.If UTC time is not specified, the first start time is determined as (time of message receipt + offset), else, the first start time is determined as (UTC time + offset). Subsequent start times = first start time + k * period (where, k > 0).If the Reader does not support UTC clock (as indicated by HasUTCClockCapability), and it receives the UTC time as part of the PeriodicTriggerValue parameter from the Client, the Reader SHALL return an error. See also LLRP Specification Section 10.2.1.1.1.1 and LLRP Specification Section 16.2.4.1.1.1.1 .

Field Summary

protected UnsignedInteger	offset
protected UnsignedInteger	period
static SignedShort	TYPENUM
protected UTCTimestamp	uTCTimestamp

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

RESERVEDLENGTH, TYPENUMBERLENGTH

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

bitLength

Constructor Summary

PeriodicTriggerValue()
empty constructor to create new parameter.

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

PeriodicTriggerValue(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)
UnsignedInteger	getOffset() get offset of type UnsignedInteger.
UnsignedInteger	getPeriod() get period of type UnsignedInteger.
SignedShort	getTypeNum() type number uniquely identifies a parameter.
UTCTimestamp	getUTCTimestamp() get uTCTimestamp of type UTCTimestamp .
static java.lang.Integer	length() For TLV Parameter length can not be determined at compile time.
void	setOffset(UnsignedInteger offset) set offset of type UnsignedInteger .
void	setPeriod(UnsignedInteger period) set period of type UnsignedInteger .
void	setUTCTimestamp(UTCTimestamp uTCTimestamp) set uTCTimestamp of type UTCTimestamp.
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

offset

protected UnsignedInteger offset

period

protected UnsignedInteger period

uTCTimestamp

protected UTCTimestamp uTCTimestamp

Constructor Detail

PeriodicTriggerValue

public PeriodicTriggerValue()

empty constructor to create new parameter.

PeriodicTriggerValue

public PeriodicTriggerValue(LLRPBitList list)

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

Parameters:

list - to be decoded

PeriodicTriggerValue

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

setOffset

public void setOffset(UnsignedInteger offset)

set offset of type UnsignedInteger .

Parameters:

offset - to be set

setPeriod

public void setPeriod(UnsignedInteger period)

set period of type UnsignedInteger .

Parameters:

period - to be set

setUTCTimestamp

public void setUTCTimestamp(UTCTimestamp uTCTimestamp)

set uTCTimestamp of type UTCTimestamp.

Parameters:

uTCTimestamp - to be set

getOffset

public UnsignedInteger getOffset()

get offset of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getPeriod

public UnsignedInteger getPeriod()

get period of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getUTCTimestamp

public UTCTimestamp getUTCTimestamp()

get uTCTimestamp of type UTCTimestamp .

Returns:

UTCTimestamp

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