org.llrp.ltk.generated.parameters
Class FrequencyRSSILevelEntry

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

public class FrequencyRSSILevelEntry
extends TLVParameter

DescriptionFrequency: The frequency on which the measurement was taken, specified in kHz.Bandwidth: The measurement bandwidth of the measurement in kHz.Average RSSI: The average power level observed at this frequency in dBm.Peak RSSI: The peak power level observed at this frequency in dBm. See also LLRP Specification Section 13.2.4.1 and LLRP Specification Section 16.2.7.4.1 .

Field Summary

protected SignedByte	averageRSSI
protected UnsignedInteger	bandwidth
protected UnsignedInteger	frequency
protected SignedByte	peakRSSI
protected Timestamp	timestamp
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

FrequencyRSSILevelEntry()
empty constructor to create new parameter.

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

FrequencyRSSILevelEntry(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.
SignedByte	getAverageRSSI() get averageRSSI of type SignedByte.
UnsignedInteger	getBandwidth() get bandwidth of type UnsignedInteger.
UnsignedInteger	getFrequency() get frequency of type UnsignedInteger.
java.lang.String	getName() name of parameter (same as class name)
SignedByte	getPeakRSSI() get peakRSSI of type SignedByte.
Timestamp	getTimestamp() get timestamp of type Timestamp .
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	setAverageRSSI(SignedByte averageRSSI) set averageRSSI of type SignedByte .
void	setBandwidth(UnsignedInteger bandwidth) set bandwidth of type UnsignedInteger .
void	setFrequency(UnsignedInteger frequency) set frequency of type UnsignedInteger .
void	setPeakRSSI(SignedByte peakRSSI) set peakRSSI of type SignedByte .
void	setTimestamp(Timestamp timestamp) set timestamp of type Timestamp.
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

frequency

protected UnsignedInteger frequency

bandwidth

protected UnsignedInteger bandwidth

averageRSSI

protected SignedByte averageRSSI

peakRSSI

protected SignedByte peakRSSI

timestamp

protected Timestamp timestamp

Constructor Detail

FrequencyRSSILevelEntry

public FrequencyRSSILevelEntry()

empty constructor to create new parameter.

FrequencyRSSILevelEntry

public FrequencyRSSILevelEntry(LLRPBitList list)

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

Parameters:

list - to be decoded

FrequencyRSSILevelEntry

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

setFrequency

public void setFrequency(UnsignedInteger frequency)

set frequency of type UnsignedInteger .

Parameters:

frequency - to be set

setBandwidth

public void setBandwidth(UnsignedInteger bandwidth)

set bandwidth of type UnsignedInteger .

Parameters:

bandwidth - to be set

setAverageRSSI

public void setAverageRSSI(SignedByte averageRSSI)

set averageRSSI of type SignedByte .

Parameters:

averageRSSI - to be set

setPeakRSSI

public void setPeakRSSI(SignedByte peakRSSI)

set peakRSSI of type SignedByte .

Parameters:

peakRSSI - to be set

setTimestamp

public void setTimestamp(Timestamp timestamp)

set timestamp of type Timestamp.

Parameters:

timestamp - to be set

getFrequency

public UnsignedInteger getFrequency()

get frequency of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getBandwidth

public UnsignedInteger getBandwidth()

get bandwidth of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getAverageRSSI

public SignedByte getAverageRSSI()

get averageRSSI of type SignedByte.

Returns:

type SignedByte to be set

getPeakRSSI

public SignedByte getPeakRSSI()

get peakRSSI of type SignedByte.

Returns:

type SignedByte to be set

getTimestamp

public Timestamp getTimestamp()

get timestamp of type Timestamp .

Returns:

Timestamp

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