org.llrp.ltk.generated.parameters
Class KeepaliveSpec

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

public class KeepaliveSpec
extends TLVParameter

This parameter carries the specification for the keepalive message generation by the Reader. This includes the definition of the periodic trigger to send the keepalive message. See also LLRP Specification Section 12.2.4 and LLRP Specification Section 16.2.6.4 .

Field Summary

protected KeepaliveTriggerType	keepaliveTriggerType
protected UnsignedInteger	periodicTriggerValue
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

KeepaliveSpec()
empty constructor to create new parameter.

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

KeepaliveSpec(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.
KeepaliveTriggerType	getKeepaliveTriggerType() get keepaliveTriggerType of type KeepaliveTriggerType.
java.lang.String	getName() name of parameter (same as class name)
UnsignedInteger	getPeriodicTriggerValue() get periodicTriggerValue 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	setKeepaliveTriggerType(KeepaliveTriggerType keepaliveTriggerType) set keepaliveTriggerType of type KeepaliveTriggerType .
void	setPeriodicTriggerValue(UnsignedInteger periodicTriggerValue) set periodicTriggerValue 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

keepaliveTriggerType

protected KeepaliveTriggerType keepaliveTriggerType

periodicTriggerValue

protected UnsignedInteger periodicTriggerValue

Constructor Detail

KeepaliveSpec

public KeepaliveSpec()

empty constructor to create new parameter.

KeepaliveSpec

public KeepaliveSpec(LLRPBitList list)

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

Parameters:

list - to be decoded

KeepaliveSpec

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

setKeepaliveTriggerType

public void setKeepaliveTriggerType(KeepaliveTriggerType keepaliveTriggerType)

set keepaliveTriggerType of type KeepaliveTriggerType .

Parameters:

keepaliveTriggerType - to be set

setPeriodicTriggerValue

public void setPeriodicTriggerValue(UnsignedInteger periodicTriggerValue)

set periodicTriggerValue of type UnsignedInteger .

Parameters:

periodicTriggerValue - to be set

getKeepaliveTriggerType

public KeepaliveTriggerType getKeepaliveTriggerType()

get keepaliveTriggerType of type KeepaliveTriggerType.

Returns:

KeepaliveTriggerType

getPeriodicTriggerValue

public UnsignedInteger getPeriodicTriggerValue()

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