org.llrp.ltk.generated.parameters
Class RFTransmitter

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

public class RFTransmitter
extends TLVParameter

This Parameter carries the RF transmitter information. The Transmit Power defines the transmit power for the antenna expressed as an index into the TransmitPowerTable (section 9.2.4.1.1). The HopTableID is the index of the frequency hop table to be used by the Reader (section 9.2.4.1.2.1) and is used when operating in frequency-hopping regulatory regions. This field is ignored in non-frequency-hopping regulatory regions. The ChannelIndex is the one-based channel index in the FixedFrequencyTable to use during transmission (section 9.2.4.1.2.2) and is used when operating in non-frequency-hopping regulatory regions. This field is ignored in frequency-hopping regulatory regions. See also LLRP Specification Section 12.2.6.2 and LLRP Specification Section 16.2.6.8 .

Field Summary

protected UnsignedShort	channelIndex
protected UnsignedShort	hopTableID
protected UnsignedShort	transmitPower
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

RFTransmitter()
empty constructor to create new parameter.

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

RFTransmitter(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	getChannelIndex() get channelIndex of type UnsignedShort.
UnsignedShort	getHopTableID() get hopTableID of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
UnsignedShort	getTransmitPower() get transmitPower of type UnsignedShort.
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	setChannelIndex(UnsignedShort channelIndex) set channelIndex of type UnsignedShort .
void	setHopTableID(UnsignedShort hopTableID) set hopTableID of type UnsignedShort .
void	setTransmitPower(UnsignedShort transmitPower) set transmitPower of type UnsignedShort .
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

hopTableID

protected UnsignedShort hopTableID

channelIndex

protected UnsignedShort channelIndex

transmitPower

protected UnsignedShort transmitPower

Constructor Detail

RFTransmitter

public RFTransmitter()

empty constructor to create new parameter.

RFTransmitter

public RFTransmitter(LLRPBitList list)

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

Parameters:

list - to be decoded

RFTransmitter

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

setHopTableID

public void setHopTableID(UnsignedShort hopTableID)

set hopTableID of type UnsignedShort .

Parameters:

hopTableID - to be set

setChannelIndex

public void setChannelIndex(UnsignedShort channelIndex)

set channelIndex of type UnsignedShort .

Parameters:

channelIndex - to be set

setTransmitPower

public void setTransmitPower(UnsignedShort transmitPower)

set transmitPower of type UnsignedShort .

Parameters:

transmitPower - to be set

getHopTableID

public UnsignedShort getHopTableID()

get hopTableID of type UnsignedShort.

Returns:

type UnsignedShort to be set

getChannelIndex

public UnsignedShort getChannelIndex()

get channelIndex of type UnsignedShort.

Returns:

type UnsignedShort to be set

getTransmitPower

public UnsignedShort getTransmitPower()

get transmitPower of type UnsignedShort.

Returns:

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