org.llrp.ltk.generated.parameters
Class AntennaProperties

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

public class AntennaProperties
extends TLVParameter

This parameter carries a single antenna's properties. The properties include the gain and the connectivity status of the antenna.The antenna gain is the composite gain and includes the loss of the associated cable from the Reader to the antenna. The gain is represented in dBi*100 to allow fractional dBi representation. See also LLRP Specification Section 12.2.5 and LLRP Specification Section 16.2.6.5 .

Field Summary

protected Bit	antennaConnected
protected SignedShort	antennaGain
protected UnsignedShort	antennaID
protected BitList	reserved0
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

AntennaProperties()
empty constructor to create new parameter.

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

AntennaProperties(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.
Bit	getAntennaConnected() get antennaConnected of type Bit.
SignedShort	getAntennaGain() get antennaGain of type SignedShort.
UnsignedShort	getAntennaID() get antennaID of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
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	setAntennaConnected(Bit antennaConnected) set antennaConnected of type Bit .
void	setAntennaGain(SignedShort antennaGain) set antennaGain of type SignedShort .
void	setAntennaID(UnsignedShort antennaID) set antennaID 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

antennaConnected

protected Bit antennaConnected

reserved0

protected BitList reserved0

antennaID

protected UnsignedShort antennaID

antennaGain

protected SignedShort antennaGain

Constructor Detail

AntennaProperties

public AntennaProperties()

empty constructor to create new parameter.

AntennaProperties

public AntennaProperties(LLRPBitList list)

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

Parameters:

list - to be decoded

AntennaProperties

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

setAntennaConnected

public void setAntennaConnected(Bit antennaConnected)

set antennaConnected of type Bit .

Parameters:

antennaConnected - to be set

setAntennaID

public void setAntennaID(UnsignedShort antennaID)

set antennaID of type UnsignedShort .

Parameters:

antennaID - to be set

setAntennaGain

public void setAntennaGain(SignedShort antennaGain)

set antennaGain of type SignedShort .

Parameters:

antennaGain - to be set

getAntennaConnected

public Bit getAntennaConnected()

get antennaConnected of type Bit.

Returns:

type Bit to be set

getAntennaID

public UnsignedShort getAntennaID()

get antennaID of type UnsignedShort.

Returns:

type UnsignedShort to be set

getAntennaGain

public SignedShort getAntennaGain()

get antennaGain 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