org.llrp.ltk.generated.parameters
Class ReceiveSensitivityTableEntry

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

public class ReceiveSensitivityTableEntry
extends TLVParameter

This parameter specifies the index into the Receive Sensitivity Table for a receive sensitivity value. The receive sensitivity is expressed in dB and the value is relative to the maximum sensitivity. If the Reader does not allow control of receive sensitivity, a table of one entry is returned, the entry having the value of zero.If the Reader allows control of receive sensitivity and the Reader also supports multiple antennas where the antennas can have different receive sensitivity values, then the Receive Sensitivity Table should be a set of values representing the union of sensitivity values for all antennas. See also LLRP Specification Section 9.2.1.1 and LLRP Specification Section 16.2.3.1.1 .

Field Summary

protected UnsignedShort	index
protected SignedShort	receiveSensitivityValue
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

ReceiveSensitivityTableEntry()
empty constructor to create new parameter.

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

ReceiveSensitivityTableEntry(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.
UnsignedShort	getIndex() get index of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
SignedShort	getReceiveSensitivityValue() get receiveSensitivityValue of type SignedShort.
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	setIndex(UnsignedShort index) set index of type UnsignedShort .
void	setReceiveSensitivityValue(SignedShort receiveSensitivityValue) set receiveSensitivityValue of type SignedShort .
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

index

protected UnsignedShort index

receiveSensitivityValue

protected SignedShort receiveSensitivityValue

Constructor Detail

ReceiveSensitivityTableEntry

public ReceiveSensitivityTableEntry()

empty constructor to create new parameter.

ReceiveSensitivityTableEntry

public ReceiveSensitivityTableEntry(LLRPBitList list)

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

Parameters:

list - to be decoded

ReceiveSensitivityTableEntry

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

setIndex

public void setIndex(UnsignedShort index)

set index of type UnsignedShort .

Parameters:

index - to be set

setReceiveSensitivityValue

public void setReceiveSensitivityValue(SignedShort receiveSensitivityValue)

set receiveSensitivityValue of type SignedShort .

Parameters:

receiveSensitivityValue - to be set

getIndex

public UnsignedShort getIndex()

get index of type UnsignedShort.

Returns:

type UnsignedShort to be set

getReceiveSensitivityValue

public SignedShort getReceiveSensitivityValue()

get receiveSensitivityValue of type SignedShort.

Returns:

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