org.llrp.ltk.generated.parameters
Class HoppingEvent

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

public class HoppingEvent
extends TLVParameter

A Reader reports this event every time it hops frequency.NextChannelIndex: This is the one-based ChannelIindex of the next channel to which the Reader is going to hop change to. The channel Ids are listed in the Frequency Hop Table. See also LLRP Specification Section 13.2.6.2 and LLRP Specification Section 16.2.7.6.1 .

Field Summary

protected UnsignedShort	hopTableID
protected UnsignedShort	nextChannelIndex
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

HoppingEvent()
empty constructor to create new parameter.

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

HoppingEvent(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.
UnsignedShort	getHopTableID() get hopTableID of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
UnsignedShort	getNextChannelIndex() get nextChannelIndex of type UnsignedShort.
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	setHopTableID(UnsignedShort hopTableID) set hopTableID of type UnsignedShort .
void	setNextChannelIndex(UnsignedShort nextChannelIndex) set nextChannelIndex of type UnsignedShort .
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

hopTableID

protected UnsignedShort hopTableID

nextChannelIndex

protected UnsignedShort nextChannelIndex

Constructor Detail

HoppingEvent

public HoppingEvent()

empty constructor to create new parameter.

HoppingEvent

public HoppingEvent(LLRPBitList list)

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

Parameters:

list - to be decoded

HoppingEvent

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

setHopTableID

public void setHopTableID(UnsignedShort hopTableID)

set hopTableID of type UnsignedShort .

Parameters:

hopTableID - to be set

setNextChannelIndex

public void setNextChannelIndex(UnsignedShort nextChannelIndex)

set nextChannelIndex of type UnsignedShort .

Parameters:

nextChannelIndex - to be set

getHopTableID

public UnsignedShort getHopTableID()

get hopTableID of type UnsignedShort.

Returns:

type UnsignedShort to be set

getNextChannelIndex

public UnsignedShort getNextChannelIndex()

get nextChannelIndex of type UnsignedShort.

Returns:

type UnsignedShort 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