org.llrp.ltk.generated.parameters
Class FrequencyInformation

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

public class FrequencyInformation
extends TLVParameter

Describes the fixed frequency or hopping frequencies supported in this UHFBand. See also LLRP Specification Section 9.2.4.1.2 and LLRP Specification Section 16.2.3.4.1.2 .

Field Summary

protected FixedFrequencyTable	fixedFrequencyTable
protected java.util.List<FrequencyHopTable>	frequencyHopTableList
protected Bit	hopping
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

FrequencyInformation()
empty constructor to create new parameter.

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

FrequencyInformation(LLRPBitList list)
Constructor to create parameter from binary encoded parameter calls decodeBinary to decode parameter.

Method Summary

void	addToFrequencyHopTableList(FrequencyHopTable frequencyHopTable) add element frequencyHopTable of type FrequencyHopTable .
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.
FixedFrequencyTable	getFixedFrequencyTable() get fixedFrequencyTable of type FixedFrequencyTable .
java.util.List<FrequencyHopTable>	getFrequencyHopTableList() get frequencyHopTableList of type List <FrequencyHopTable> .
Bit	getHopping() get hopping of type Bit.
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	setFixedFrequencyTable(FixedFrequencyTable fixedFrequencyTable) set fixedFrequencyTable of type FixedFrequencyTable.
void	setFrequencyHopTableList(java.util.List<FrequencyHopTable> frequencyHopTableList) set frequencyHopTableList of type List <FrequencyHopTable>.
void	setHopping(Bit hopping) set hopping of type Bit .
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

hopping

protected Bit hopping

reserved0

protected BitList reserved0

frequencyHopTableList

protected java.util.List<FrequencyHopTable> frequencyHopTableList

fixedFrequencyTable

protected FixedFrequencyTable fixedFrequencyTable

Constructor Detail

FrequencyInformation

public FrequencyInformation()

empty constructor to create new parameter.

FrequencyInformation

public FrequencyInformation(LLRPBitList list)

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

Parameters:

list - to be decoded

FrequencyInformation

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

setHopping

public void setHopping(Bit hopping)

set hopping of type Bit .

Parameters:

hopping - to be set

setFrequencyHopTableList

public void setFrequencyHopTableList(java.util.List<FrequencyHopTable> frequencyHopTableList)

set frequencyHopTableList of type List <FrequencyHopTable>.

Parameters:

frequencyHopTableList - to be set

setFixedFrequencyTable

public void setFixedFrequencyTable(FixedFrequencyTable fixedFrequencyTable)

set fixedFrequencyTable of type FixedFrequencyTable.

Parameters:

fixedFrequencyTable - to be set

getHopping

public Bit getHopping()

get hopping of type Bit.

Returns:

type Bit to be set

getFrequencyHopTableList

public java.util.List<FrequencyHopTable> getFrequencyHopTableList()

get frequencyHopTableList of type List <FrequencyHopTable> .

Returns:

List <FrequencyHopTable>

getFixedFrequencyTable

public FixedFrequencyTable getFixedFrequencyTable()

get fixedFrequencyTable of type FixedFrequencyTable .

Returns:

FixedFrequencyTable

addToFrequencyHopTableList

public void addToFrequencyHopTableList(FrequencyHopTable frequencyHopTable)

add element frequencyHopTable of type FrequencyHopTable .

Parameters:

frequencyHopTable - of type FrequencyHopTable

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