org.llrp.ltk.generated.parameters
Class InventoryParameterSpec

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

public class InventoryParameterSpec
extends TLVParameter

This parameter defines the inventory operation to be performed at all antennas specified in the corresponding AISpec. This parameter is composed of an InventoryParameterSpecID, a ProtocolID, and zero or more optional antenna configuration parameters. Antenna configurations for antennas not indicated by the AntennaIDs within the AISpec are ignored by the reader. See also LLRP Specification Section 10.2.2.2 and LLRP Specification Section 16.2.4.2.2 .

Field Summary

protected java.util.List<AntennaConfiguration>	antennaConfigurationList
protected java.util.List<Custom>	customList
protected UnsignedShort	inventoryParameterSpecID
protected AirProtocols	protocolID
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

InventoryParameterSpec()
empty constructor to create new parameter.

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

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

Method Summary

void	addToAntennaConfigurationList(AntennaConfiguration antennaConfiguration) add element antennaConfiguration of type AntennaConfiguration .
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.
java.util.List<AntennaConfiguration>	getAntennaConfigurationList() get antennaConfigurationList of type List <AntennaConfiguration> .
java.util.List<Custom>	getCustomList() get customList of type List <Custom> .
UnsignedShort	getInventoryParameterSpecID() get inventoryParameterSpecID of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
AirProtocols	getProtocolID() get protocolID of type AirProtocols.
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	setAntennaConfigurationList(java.util.List<AntennaConfiguration> antennaConfigurationList) set antennaConfigurationList of type List <AntennaConfiguration>.
void	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setInventoryParameterSpecID(UnsignedShort inventoryParameterSpecID) set inventoryParameterSpecID of type UnsignedShort .
void	setProtocolID(AirProtocols protocolID) set protocolID of type AirProtocols .
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

inventoryParameterSpecID

protected UnsignedShort inventoryParameterSpecID

protocolID

protected AirProtocols protocolID

antennaConfigurationList

protected java.util.List<AntennaConfiguration> antennaConfigurationList

customList

protected java.util.List<Custom> customList

Constructor Detail

InventoryParameterSpec

public InventoryParameterSpec()

empty constructor to create new parameter.

InventoryParameterSpec

public InventoryParameterSpec(LLRPBitList list)

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

Parameters:

list - to be decoded

InventoryParameterSpec

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

setInventoryParameterSpecID

public void setInventoryParameterSpecID(UnsignedShort inventoryParameterSpecID)

set inventoryParameterSpecID of type UnsignedShort .

Parameters:

inventoryParameterSpecID - to be set

setProtocolID

public void setProtocolID(AirProtocols protocolID)

set protocolID of type AirProtocols .

Parameters:

protocolID - to be set

setAntennaConfigurationList

public void setAntennaConfigurationList(java.util.List<AntennaConfiguration> antennaConfigurationList)

set antennaConfigurationList of type List <AntennaConfiguration>.

Parameters:

antennaConfigurationList - to be set

setCustomList

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

set customList of type List <Custom>.

Parameters:

customList - to be set

getInventoryParameterSpecID

public UnsignedShort getInventoryParameterSpecID()

get inventoryParameterSpecID of type UnsignedShort.

Returns:

type UnsignedShort to be set

getProtocolID

public AirProtocols getProtocolID()

get protocolID of type AirProtocols.

Returns:

AirProtocols

getAntennaConfigurationList

public java.util.List<AntennaConfiguration> getAntennaConfigurationList()

get antennaConfigurationList of type List <AntennaConfiguration> .

Returns:

List <AntennaConfiguration>

getCustomList

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

get customList of type List <Custom> .

Returns:

List <Custom>

addToAntennaConfigurationList

public void addToAntennaConfigurationList(AntennaConfiguration antennaConfiguration)

add element antennaConfiguration of type AntennaConfiguration .

Parameters:

antennaConfiguration - of type AntennaConfiguration

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