org.llrp.ltk.generated.parameters
Class AISpec

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

All Implemented Interfaces:

SpecParameter

public class AISpec
extends TLVParameter
implements SpecParameter

This parameter defines antenna inventory operations. See also LLRP Specification Section 10.2.2 and LLRP Specification Section 16.2.4.2 .

Field Summary

protected AISpecStopTrigger	aISpecStopTrigger
protected UnsignedShortArray	antennaIDs
protected java.util.List<Custom>	customList
protected java.util.List<InventoryParameterSpec>	inventoryParameterSpecList
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

AISpec()
empty constructor to create new parameter.

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

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

Method Summary

void	addToCustomList(Custom custom) add element custom of type Custom .
void	addToInventoryParameterSpecList(InventoryParameterSpec inventoryParameterSpec) add element inventoryParameterSpec of type InventoryParameterSpec .
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.
AISpecStopTrigger	getAISpecStopTrigger() get aISpecStopTrigger of type AISpecStopTrigger .
UnsignedShortArray	getAntennaIDs() get antennaIDs of type UnsignedShortArray.
java.util.List<Custom>	getCustomList() get customList of type List <Custom> .
java.util.List<InventoryParameterSpec>	getInventoryParameterSpecList() get inventoryParameterSpecList of type List <InventoryParameterSpec> .
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	setAISpecStopTrigger(AISpecStopTrigger aISpecStopTrigger) set aISpecStopTrigger of type AISpecStopTrigger.
void	setAntennaIDs(UnsignedShortArray antennaIDs) set antennaIDs of type UnsignedShortArray .
void	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setInventoryParameterSpecList(java.util.List<InventoryParameterSpec> inventoryParameterSpecList) set inventoryParameterSpecList of type List <InventoryParameterSpec>.
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

Methods inherited from interface org.llrp.ltk.generated.interfaces.SpecParameter

decodeBinary, encodeBinary

Field Detail

TYPENUM

public static final SignedShort TYPENUM

antennaIDs

protected UnsignedShortArray antennaIDs

aISpecStopTrigger

protected AISpecStopTrigger aISpecStopTrigger

inventoryParameterSpecList

protected java.util.List<InventoryParameterSpec> inventoryParameterSpecList

customList

protected java.util.List<Custom> customList

Constructor Detail

AISpec

public AISpec()

empty constructor to create new parameter.

AISpec

public AISpec(LLRPBitList list)

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

Parameters:

list - to be decoded

AISpec

public AISpec(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 interface SpecParameter

Specified by:

encodeXML in class LLRPParameter

Parameters:

name - of element

ns - Namespace of elements

Returns:

JDom Content object

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 interface SpecParameter

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setAntennaIDs

public void setAntennaIDs(UnsignedShortArray antennaIDs)

set antennaIDs of type UnsignedShortArray .

Parameters:

antennaIDs - to be set

setAISpecStopTrigger

public void setAISpecStopTrigger(AISpecStopTrigger aISpecStopTrigger)

set aISpecStopTrigger of type AISpecStopTrigger.

Parameters:

aISpecStopTrigger - to be set

setInventoryParameterSpecList

public void setInventoryParameterSpecList(java.util.List<InventoryParameterSpec> inventoryParameterSpecList)

set inventoryParameterSpecList of type List <InventoryParameterSpec>.

Parameters:

inventoryParameterSpecList - to be set

setCustomList

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

set customList of type List <Custom>.

Parameters:

customList - to be set

getAntennaIDs

public UnsignedShortArray getAntennaIDs()

get antennaIDs of type UnsignedShortArray.

Returns:

type UnsignedShortArray to be set

getAISpecStopTrigger

public AISpecStopTrigger getAISpecStopTrigger()

get aISpecStopTrigger of type AISpecStopTrigger .

Returns:

AISpecStopTrigger

getInventoryParameterSpecList

public java.util.List<InventoryParameterSpec> getInventoryParameterSpecList()

get inventoryParameterSpecList of type List <InventoryParameterSpec> .

Returns:

List <InventoryParameterSpec>

getCustomList

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

get customList of type List <Custom> .

Returns:

List <Custom>

addToInventoryParameterSpecList

public void addToInventoryParameterSpecList(InventoryParameterSpec inventoryParameterSpec)

add element inventoryParameterSpec of type InventoryParameterSpec .

Parameters:

inventoryParameterSpec - of type InventoryParameterSpec

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