org.llrp.ltk.generated.parameters
Class RFSurveySpec

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

All Implemented Interfaces:

SpecParameter

public class RFSurveySpec
extends TLVParameter
implements SpecParameter

This parameter defines RF Survey operations. RF Survey is an operation during which the Reader performs a scan and measures the power levels across a set of frequencies at an antenna. This parameter defines the identifier of the antenna where this survey is to be performed, the duration of the survey operation (specified via stop trigger), and the range of frequencies to measure power levels of. See also LLRP Specification Section 10.2.3 and LLRP Specification Section 16.2.4.3 .

Field Summary

protected UnsignedShort	antennaID
protected java.util.List<Custom>	customList
protected UnsignedInteger	endFrequency
protected RFSurveySpecStopTrigger	rFSurveySpecStopTrigger
protected UnsignedInteger	startFrequency
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

RFSurveySpec()
empty constructor to create new parameter.

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

RFSurveySpec(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 .
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	getAntennaID() get antennaID of type UnsignedShort.
java.util.List<Custom>	getCustomList() get customList of type List <Custom> .
UnsignedInteger	getEndFrequency() get endFrequency of type UnsignedInteger.
java.lang.String	getName() name of parameter (same as class name)
RFSurveySpecStopTrigger	getRFSurveySpecStopTrigger() get rFSurveySpecStopTrigger of type RFSurveySpecStopTrigger .
UnsignedInteger	getStartFrequency() get startFrequency of type UnsignedInteger.
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	setAntennaID(UnsignedShort antennaID) set antennaID of type UnsignedShort .
void	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setEndFrequency(UnsignedInteger endFrequency) set endFrequency of type UnsignedInteger .
void	setRFSurveySpecStopTrigger(RFSurveySpecStopTrigger rFSurveySpecStopTrigger) set rFSurveySpecStopTrigger of type RFSurveySpecStopTrigger.
void	setStartFrequency(UnsignedInteger startFrequency) set startFrequency of type UnsignedInteger .
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

Methods inherited from interface org.llrp.ltk.generated.interfaces.SpecParameter

decodeBinary, encodeBinary

Field Detail

TYPENUM

public static final SignedShort TYPENUM

antennaID

protected UnsignedShort antennaID

startFrequency

protected UnsignedInteger startFrequency

endFrequency

protected UnsignedInteger endFrequency

rFSurveySpecStopTrigger

protected RFSurveySpecStopTrigger rFSurveySpecStopTrigger

customList

protected java.util.List<Custom> customList

Constructor Detail

RFSurveySpec

public RFSurveySpec()

empty constructor to create new parameter.

RFSurveySpec

public RFSurveySpec(LLRPBitList list)

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

Parameters:

list - to be decoded

RFSurveySpec

public RFSurveySpec(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 interface SpecParameter

Specified by:

encodeXML in class LLRPParameter

Parameters:

name - of element

ns - Namespace of elements

Returns:

JDom Content object

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 interface SpecParameter

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setAntennaID

public void setAntennaID(UnsignedShort antennaID)

set antennaID of type UnsignedShort .

Parameters:

antennaID - to be set

setStartFrequency

public void setStartFrequency(UnsignedInteger startFrequency)

set startFrequency of type UnsignedInteger .

Parameters:

startFrequency - to be set

setEndFrequency

public void setEndFrequency(UnsignedInteger endFrequency)

set endFrequency of type UnsignedInteger .

Parameters:

endFrequency - to be set

setRFSurveySpecStopTrigger

public void setRFSurveySpecStopTrigger(RFSurveySpecStopTrigger rFSurveySpecStopTrigger)

set rFSurveySpecStopTrigger of type RFSurveySpecStopTrigger.

Parameters:

rFSurveySpecStopTrigger - to be set

setCustomList

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

set customList of type List <Custom>.

Parameters:

customList - to be set

getAntennaID

public UnsignedShort getAntennaID()

get antennaID of type UnsignedShort.

Returns:

type UnsignedShort to be set

getStartFrequency

public UnsignedInteger getStartFrequency()

get startFrequency of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getEndFrequency

public UnsignedInteger getEndFrequency()

get endFrequency of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getRFSurveySpecStopTrigger

public RFSurveySpecStopTrigger getRFSurveySpecStopTrigger()

get rFSurveySpecStopTrigger of type RFSurveySpecStopTrigger .

Returns:

RFSurveySpecStopTrigger

getCustomList

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

get customList of type List <Custom> .

Returns:

List <Custom>

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