org.llrp.ltk.generated.parameters
Class GeneralDeviceCapabilities

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

public class GeneralDeviceCapabilities
extends TLVParameter

This parameter carries the general capabilities of the device like supported air protocols, version of the Reader firmware, device hardware and software information, and receive sensitivity table. See also LLRP Specification Section 9.1.2 and LLRP Specification Section 16.2.3.1 .

Field Summary

protected Bit	canSetAntennaProperties
protected UnsignedInteger	deviceManufacturerName
protected GPIOCapabilities	gPIOCapabilities
protected Bit	hasUTCClockCapability
protected UnsignedShort	maxNumberOfAntennaSupported
protected UnsignedInteger	modelName
protected java.util.List<PerAntennaAirProtocol>	perAntennaAirProtocolList
protected java.util.List<PerAntennaReceiveSensitivityRange>	perAntennaReceiveSensitivityRangeList
protected UTF8String_UTF_8	readerFirmwareVersion
protected java.util.List<ReceiveSensitivityTableEntry>	receiveSensitivityTableEntryList
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

GeneralDeviceCapabilities()
empty constructor to create new parameter.

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

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

Method Summary

void	addToPerAntennaAirProtocolList(PerAntennaAirProtocol perAntennaAirProtocol) add element perAntennaAirProtocol of type PerAntennaAirProtocol .
void	addToPerAntennaReceiveSensitivityRangeList(PerAntennaReceiveSensitivityRange perAntennaReceiveSensitivityRange) add element perAntennaReceiveSensitivityRange of type PerAntennaReceiveSensitivityRange .
void	addToReceiveSensitivityTableEntryList(ReceiveSensitivityTableEntry receiveSensitivityTableEntry) add element receiveSensitivityTableEntry of type ReceiveSensitivityTableEntry .
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	getCanSetAntennaProperties() get canSetAntennaProperties of type Bit.
UnsignedInteger	getDeviceManufacturerName() get deviceManufacturerName of type UnsignedInteger.
GPIOCapabilities	getGPIOCapabilities() get gPIOCapabilities of type GPIOCapabilities .
Bit	getHasUTCClockCapability() get hasUTCClockCapability of type Bit.
UnsignedShort	getMaxNumberOfAntennaSupported() get maxNumberOfAntennaSupported of type UnsignedShort.
UnsignedInteger	getModelName() get modelName of type UnsignedInteger.
java.lang.String	getName() name of parameter (same as class name)
java.util.List<PerAntennaAirProtocol>	getPerAntennaAirProtocolList() get perAntennaAirProtocolList of type List <PerAntennaAirProtocol> .
java.util.List<PerAntennaReceiveSensitivityRange>	getPerAntennaReceiveSensitivityRangeList() get perAntennaReceiveSensitivityRangeList of type List <PerAntennaReceiveSensitivityRange> .
UTF8String_UTF_8	getReaderFirmwareVersion() get readerFirmwareVersion of type UTF8String_UTF_8.
java.util.List<ReceiveSensitivityTableEntry>	getReceiveSensitivityTableEntryList() get receiveSensitivityTableEntryList of type List <ReceiveSensitivityTableEntry> .
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	setCanSetAntennaProperties(Bit canSetAntennaProperties) set canSetAntennaProperties of type Bit .
void	setDeviceManufacturerName(UnsignedInteger deviceManufacturerName) set deviceManufacturerName of type UnsignedInteger .
void	setGPIOCapabilities(GPIOCapabilities gPIOCapabilities) set gPIOCapabilities of type GPIOCapabilities.
void	setHasUTCClockCapability(Bit hasUTCClockCapability) set hasUTCClockCapability of type Bit .
void	setMaxNumberOfAntennaSupported(UnsignedShort maxNumberOfAntennaSupported) set maxNumberOfAntennaSupported of type UnsignedShort .
void	setModelName(UnsignedInteger modelName) set modelName of type UnsignedInteger .
void	setPerAntennaAirProtocolList(java.util.List<PerAntennaAirProtocol> perAntennaAirProtocolList) set perAntennaAirProtocolList of type List <PerAntennaAirProtocol>.
void	setPerAntennaReceiveSensitivityRangeList(java.util.List<PerAntennaReceiveSensitivityRange> perAntennaReceiveSensitivityRangeList) set perAntennaReceiveSensitivityRangeList of type List <PerAntennaReceiveSensitivityRange>.
void	setReaderFirmwareVersion(UTF8String_UTF_8 readerFirmwareVersion) set readerFirmwareVersion of type UTF8String_UTF_8 .
void	setReceiveSensitivityTableEntryList(java.util.List<ReceiveSensitivityTableEntry> receiveSensitivityTableEntryList) set receiveSensitivityTableEntryList of type List <ReceiveSensitivityTableEntry>.
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

maxNumberOfAntennaSupported

protected UnsignedShort maxNumberOfAntennaSupported

canSetAntennaProperties

protected Bit canSetAntennaProperties

hasUTCClockCapability

protected Bit hasUTCClockCapability

reserved0

protected BitList reserved0

deviceManufacturerName

protected UnsignedInteger deviceManufacturerName

modelName

protected UnsignedInteger modelName

readerFirmwareVersion

protected UTF8String_UTF_8 readerFirmwareVersion

receiveSensitivityTableEntryList

protected java.util.List<ReceiveSensitivityTableEntry> receiveSensitivityTableEntryList

perAntennaReceiveSensitivityRangeList

protected java.util.List<PerAntennaReceiveSensitivityRange> perAntennaReceiveSensitivityRangeList

gPIOCapabilities

protected GPIOCapabilities gPIOCapabilities

perAntennaAirProtocolList

protected java.util.List<PerAntennaAirProtocol> perAntennaAirProtocolList

Constructor Detail

GeneralDeviceCapabilities

public GeneralDeviceCapabilities()

empty constructor to create new parameter.

GeneralDeviceCapabilities

public GeneralDeviceCapabilities(LLRPBitList list)

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

Parameters:

list - to be decoded

GeneralDeviceCapabilities

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

setMaxNumberOfAntennaSupported

public void setMaxNumberOfAntennaSupported(UnsignedShort maxNumberOfAntennaSupported)

set maxNumberOfAntennaSupported of type UnsignedShort .

Parameters:

maxNumberOfAntennaSupported - to be set

setCanSetAntennaProperties

public void setCanSetAntennaProperties(Bit canSetAntennaProperties)

set canSetAntennaProperties of type Bit .

Parameters:

canSetAntennaProperties - to be set

setHasUTCClockCapability

public void setHasUTCClockCapability(Bit hasUTCClockCapability)

set hasUTCClockCapability of type Bit .

Parameters:

hasUTCClockCapability - to be set

setDeviceManufacturerName

public void setDeviceManufacturerName(UnsignedInteger deviceManufacturerName)

set deviceManufacturerName of type UnsignedInteger .

Parameters:

deviceManufacturerName - to be set

setModelName

public void setModelName(UnsignedInteger modelName)

set modelName of type UnsignedInteger .

Parameters:

modelName - to be set

setReaderFirmwareVersion

public void setReaderFirmwareVersion(UTF8String_UTF_8 readerFirmwareVersion)

set readerFirmwareVersion of type UTF8String_UTF_8 .

Parameters:

readerFirmwareVersion - to be set

setReceiveSensitivityTableEntryList

public void setReceiveSensitivityTableEntryList(java.util.List<ReceiveSensitivityTableEntry> receiveSensitivityTableEntryList)

set receiveSensitivityTableEntryList of type List <ReceiveSensitivityTableEntry>.

Parameters:

receiveSensitivityTableEntryList - to be set

setPerAntennaReceiveSensitivityRangeList

public void setPerAntennaReceiveSensitivityRangeList(java.util.List<PerAntennaReceiveSensitivityRange> perAntennaReceiveSensitivityRangeList)

set perAntennaReceiveSensitivityRangeList of type List <PerAntennaReceiveSensitivityRange>.

Parameters:

perAntennaReceiveSensitivityRangeList - to be set

setGPIOCapabilities

public void setGPIOCapabilities(GPIOCapabilities gPIOCapabilities)

set gPIOCapabilities of type GPIOCapabilities.

Parameters:

gPIOCapabilities - to be set

setPerAntennaAirProtocolList

public void setPerAntennaAirProtocolList(java.util.List<PerAntennaAirProtocol> perAntennaAirProtocolList)

set perAntennaAirProtocolList of type List <PerAntennaAirProtocol>.

Parameters:

perAntennaAirProtocolList - to be set

getMaxNumberOfAntennaSupported

public UnsignedShort getMaxNumberOfAntennaSupported()

get maxNumberOfAntennaSupported of type UnsignedShort.

Returns:

type UnsignedShort to be set

getCanSetAntennaProperties

public Bit getCanSetAntennaProperties()

get canSetAntennaProperties of type Bit.

Returns:

type Bit to be set

getHasUTCClockCapability

public Bit getHasUTCClockCapability()

get hasUTCClockCapability of type Bit.

Returns:

type Bit to be set

getDeviceManufacturerName

public UnsignedInteger getDeviceManufacturerName()

get deviceManufacturerName of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getModelName

public UnsignedInteger getModelName()

get modelName of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getReaderFirmwareVersion

public UTF8String_UTF_8 getReaderFirmwareVersion()

get readerFirmwareVersion of type UTF8String_UTF_8.

Returns:

UTF8String_UTF_8

getReceiveSensitivityTableEntryList

public java.util.List<ReceiveSensitivityTableEntry> getReceiveSensitivityTableEntryList()

get receiveSensitivityTableEntryList of type List <ReceiveSensitivityTableEntry> .

Returns:

List <ReceiveSensitivityTableEntry>

getPerAntennaReceiveSensitivityRangeList

public java.util.List<PerAntennaReceiveSensitivityRange> getPerAntennaReceiveSensitivityRangeList()

get perAntennaReceiveSensitivityRangeList of type List <PerAntennaReceiveSensitivityRange> .

Returns:

List <PerAntennaReceiveSensitivityRange>

getGPIOCapabilities

public GPIOCapabilities getGPIOCapabilities()

get gPIOCapabilities of type GPIOCapabilities .

Returns:

GPIOCapabilities

getPerAntennaAirProtocolList

public java.util.List<PerAntennaAirProtocol> getPerAntennaAirProtocolList()

get perAntennaAirProtocolList of type List <PerAntennaAirProtocol> .

Returns:

List <PerAntennaAirProtocol>

addToReceiveSensitivityTableEntryList

public void addToReceiveSensitivityTableEntryList(ReceiveSensitivityTableEntry receiveSensitivityTableEntry)

add element receiveSensitivityTableEntry of type ReceiveSensitivityTableEntry .

Parameters:

receiveSensitivityTableEntry - of type ReceiveSensitivityTableEntry

addToPerAntennaReceiveSensitivityRangeList

public void addToPerAntennaReceiveSensitivityRangeList(PerAntennaReceiveSensitivityRange perAntennaReceiveSensitivityRange)

add element perAntennaReceiveSensitivityRange of type PerAntennaReceiveSensitivityRange .

Parameters:

perAntennaReceiveSensitivityRange - of type PerAntennaReceiveSensitivityRange

addToPerAntennaAirProtocolList

public void addToPerAntennaAirProtocolList(PerAntennaAirProtocol perAntennaAirProtocol)

add element perAntennaAirProtocol of type PerAntennaAirProtocol .

Parameters:

perAntennaAirProtocol - of type PerAntennaAirProtocol

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