org.llrp.ltk.generated.parameters
Class FrequencyHopTable

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

public class FrequencyHopTable
extends TLVParameter

This parameter carries the frequency hop table parameters. This is used for Readers operating in regions with frequency hopping regulatory requirements. If the Reader is capable of storing multiple hop tables, the Reader may send all of them to the Client.HopTableID which is the index of the frequency hop table returned by the Reader.This is followed by a list of the frequencies (in kKHhz) in hop table order. The one-based position of a frequency in the list is defined as its ChannelIndex (i.e. the first frequency is referred to as ChannelIndex one). See also LLRP Specification Section 9.2.4.1.2.1 and LLRP Specification Section 16.2.3.4.1.2.1 .

Field Summary

protected UnsignedIntegerArray	frequency
protected UnsignedByte	hopTableID
protected BitList	reserved0
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

FrequencyHopTable()
empty constructor to create new parameter.

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

FrequencyHopTable(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.
UnsignedIntegerArray	getFrequency() get frequency of type UnsignedIntegerArray.
UnsignedByte	getHopTableID() get hopTableID of type UnsignedByte.
java.lang.String	getName() name of parameter (same as class name)
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	setFrequency(UnsignedIntegerArray frequency) set frequency of type UnsignedIntegerArray .
void	setHopTableID(UnsignedByte hopTableID) set hopTableID of type UnsignedByte .
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 UnsignedByte hopTableID

reserved0

protected BitList reserved0

frequency

protected UnsignedIntegerArray frequency

Constructor Detail

FrequencyHopTable

public FrequencyHopTable()

empty constructor to create new parameter.

FrequencyHopTable

public FrequencyHopTable(LLRPBitList list)

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

Parameters:

list - to be decoded

FrequencyHopTable

public FrequencyHopTable(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(UnsignedByte hopTableID)

set hopTableID of type UnsignedByte .

Parameters:

hopTableID - to be set

setFrequency

public void setFrequency(UnsignedIntegerArray frequency)

set frequency of type UnsignedIntegerArray .

Parameters:

frequency - to be set

getHopTableID

public UnsignedByte getHopTableID()

get hopTableID of type UnsignedByte.

Returns:

type UnsignedByte to be set

getFrequency

public UnsignedIntegerArray getFrequency()

get frequency of type UnsignedIntegerArray.

Returns:

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