org.llrp.ltk.generated.parameters
Class RFSurveyReportData

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

public class RFSurveyReportData
extends TLVParameter

This describes the content of the RF Survey Report. See also LLRP Specification Section 13.2.4 and LLRP Specification Section 16.2.7.4 .

Field Summary

protected java.util.List<Custom>	customList
protected java.util.List<FrequencyRSSILevelEntry>	frequencyRSSILevelEntryList
protected ROSpecID	rOSpecID
protected SpecIndex	specIndex
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

RFSurveyReportData()
empty constructor to create new parameter.

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

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

Method Summary

void	addToCustomList(Custom custom) add element custom of type Custom .
void	addToFrequencyRSSILevelEntryList(FrequencyRSSILevelEntry frequencyRSSILevelEntry) add element frequencyRSSILevelEntry of type FrequencyRSSILevelEntry .
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.
java.util.List<Custom>	getCustomList() get customList of type List <Custom> .
java.util.List<FrequencyRSSILevelEntry>	getFrequencyRSSILevelEntryList() get frequencyRSSILevelEntryList of type List <FrequencyRSSILevelEntry> .
java.lang.String	getName() name of parameter (same as class name)
ROSpecID	getROSpecID() get rOSpecID of type ROSpecID .
SpecIndex	getSpecIndex() get specIndex of type SpecIndex .
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	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setFrequencyRSSILevelEntryList(java.util.List<FrequencyRSSILevelEntry> frequencyRSSILevelEntryList) set frequencyRSSILevelEntryList of type List <FrequencyRSSILevelEntry>.
void	setROSpecID(ROSpecID rOSpecID) set rOSpecID of type ROSpecID.
void	setSpecIndex(SpecIndex specIndex) set specIndex of type SpecIndex.
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

rOSpecID

protected ROSpecID rOSpecID

specIndex

protected SpecIndex specIndex

frequencyRSSILevelEntryList

protected java.util.List<FrequencyRSSILevelEntry> frequencyRSSILevelEntryList

customList

protected java.util.List<Custom> customList

Constructor Detail

RFSurveyReportData

public RFSurveyReportData()

empty constructor to create new parameter.

RFSurveyReportData

public RFSurveyReportData(LLRPBitList list)

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

Parameters:

list - to be decoded

RFSurveyReportData

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

setROSpecID

public void setROSpecID(ROSpecID rOSpecID)

set rOSpecID of type ROSpecID.

Parameters:

rOSpecID - to be set

setSpecIndex

public void setSpecIndex(SpecIndex specIndex)

set specIndex of type SpecIndex.

Parameters:

specIndex - to be set

setFrequencyRSSILevelEntryList

public void setFrequencyRSSILevelEntryList(java.util.List<FrequencyRSSILevelEntry> frequencyRSSILevelEntryList)

set frequencyRSSILevelEntryList of type List <FrequencyRSSILevelEntry>.

Parameters:

frequencyRSSILevelEntryList - to be set

setCustomList

public void setCustomList(java.util.List<Custom> customList)

set customList of type List <Custom>.

Parameters:

customList - to be set

getROSpecID

public ROSpecID getROSpecID()

get rOSpecID of type ROSpecID .

Returns:

ROSpecID

getSpecIndex

public SpecIndex getSpecIndex()

get specIndex of type SpecIndex .

Returns:

SpecIndex

getFrequencyRSSILevelEntryList

public java.util.List<FrequencyRSSILevelEntry> getFrequencyRSSILevelEntryList()

get frequencyRSSILevelEntryList of type List <FrequencyRSSILevelEntry> .

Returns:

List <FrequencyRSSILevelEntry>

getCustomList

public java.util.List<Custom> getCustomList()

get customList of type List <Custom> .

Returns:

List <Custom>

addToFrequencyRSSILevelEntryList

public void addToFrequencyRSSILevelEntryList(FrequencyRSSILevelEntry frequencyRSSILevelEntry)

add element frequencyRSSILevelEntry of type FrequencyRSSILevelEntry .

Parameters:

frequencyRSSILevelEntry - of type FrequencyRSSILevelEntry

addToCustomList

public void addToCustomList(Custom custom)

add element custom of type Custom .

Parameters:

custom - of type Custom

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