org.llrp.ltk.generated.parameters
Class C1G2InventoryCommand

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

All Implemented Interfaces:

AirProtocolInventoryCommandSettings

public class C1G2InventoryCommand
extends TLVParameter
implements AirProtocolInventoryCommandSettings

This parameter defines the C1G2 inventory-specific settings to be used during a particular C1G2 inventory operation. This comprises of C1G2Filter Parameter, C1G2RF Parameter and C1G2Singulation Parameter. It is not necessary that the Filter, RF Control and Singulation Control Parameters be specified in each and every inventory command. They are optional parameters. If not specified, the default values in the Reader are used during the inventory operation. If multiple C1G2Filter parameters are encapsulated by the Client in the C1G2InventoryCommand parameter, the ordering of the filter parameters determine the order of C1G2 air-protocol commands (e.g., Select command) generated by the Reader.The TagInventoryStateAware flag is used to determine how to process all the C1G2Filter and C1G2Singulation parameters in this command. At a functional level, if the Client is managing the tag states during an inventory operation, it would set that flag to true and pass the appropriate fields in the C1G2 Filter and C1G2 Singulation parameters. If a reader set CanDoTagInventoryStateAwareSingulation to False in LLRPCapabilities (section 9.2.2), it SHALL ignore the TagInventoryStateAware flag. See also LLRP Specification Section 15.2.1.2.1 and LLRP Specification Section 16.3.1.2.1 .

Field Summary

protected java.util.List<C1G2Filter>	c1G2FilterList
protected C1G2RFControl	c1G2RFControl
protected C1G2SingulationControl	c1G2SingulationControl
protected java.util.List<Custom>	customList
protected BitList	reserved0
protected Bit	tagInventoryStateAware
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

C1G2InventoryCommand()
empty constructor to create new parameter.

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

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

Method Summary

void	addToC1G2FilterList(C1G2Filter c1G2Filter) add element c1G2Filter of type C1G2Filter .
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<C1G2Filter>	getC1G2FilterList() get c1G2FilterList of type List <C1G2Filter> .
C1G2RFControl	getC1G2RFControl() get c1G2RFControl of type C1G2RFControl .
C1G2SingulationControl	getC1G2SingulationControl() get c1G2SingulationControl of type C1G2SingulationControl .
java.util.List<Custom>	getCustomList() get customList of type List <Custom> .
java.lang.String	getName() name of parameter (same as class name)
Bit	getTagInventoryStateAware() get tagInventoryStateAware of type Bit.
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	setC1G2FilterList(java.util.List<C1G2Filter> c1G2FilterList) set c1G2FilterList of type List <C1G2Filter>.
void	setC1G2RFControl(C1G2RFControl c1G2RFControl) set c1G2RFControl of type C1G2RFControl.
void	setC1G2SingulationControl(C1G2SingulationControl c1G2SingulationControl) set c1G2SingulationControl of type C1G2SingulationControl.
void	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setTagInventoryStateAware(Bit tagInventoryStateAware) set tagInventoryStateAware of type Bit .
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.AirProtocolInventoryCommandSettings

decodeBinary, encodeBinary

Field Detail

TYPENUM

public static final SignedShort TYPENUM

tagInventoryStateAware

protected Bit tagInventoryStateAware

reserved0

protected BitList reserved0

c1G2FilterList

protected java.util.List<C1G2Filter> c1G2FilterList

c1G2RFControl

protected C1G2RFControl c1G2RFControl

c1G2SingulationControl

protected C1G2SingulationControl c1G2SingulationControl

customList

protected java.util.List<Custom> customList

Constructor Detail

C1G2InventoryCommand

public C1G2InventoryCommand()

empty constructor to create new parameter.

C1G2InventoryCommand

public C1G2InventoryCommand(LLRPBitList list)

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

Parameters:

list - to be decoded

C1G2InventoryCommand

public C1G2InventoryCommand(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 AirProtocolInventoryCommandSettings

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 AirProtocolInventoryCommandSettings

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setTagInventoryStateAware

public void setTagInventoryStateAware(Bit tagInventoryStateAware)

set tagInventoryStateAware of type Bit .

Parameters:

tagInventoryStateAware - to be set

setC1G2FilterList

public void setC1G2FilterList(java.util.List<C1G2Filter> c1G2FilterList)

set c1G2FilterList of type List <C1G2Filter>.

Parameters:

c1G2FilterList - to be set

setC1G2RFControl

public void setC1G2RFControl(C1G2RFControl c1G2RFControl)

set c1G2RFControl of type C1G2RFControl.

Parameters:

c1G2RFControl - to be set

setC1G2SingulationControl

public void setC1G2SingulationControl(C1G2SingulationControl c1G2SingulationControl)

set c1G2SingulationControl of type C1G2SingulationControl.

Parameters:

c1G2SingulationControl - to be set

setCustomList

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

set customList of type List <Custom>.

Parameters:

customList - to be set

getTagInventoryStateAware

public Bit getTagInventoryStateAware()

get tagInventoryStateAware of type Bit.

Returns:

type Bit to be set

getC1G2FilterList

public java.util.List<C1G2Filter> getC1G2FilterList()

get c1G2FilterList of type List <C1G2Filter> .

Returns:

List <C1G2Filter>

getC1G2RFControl

public C1G2RFControl getC1G2RFControl()

get c1G2RFControl of type C1G2RFControl .

Returns:

C1G2RFControl

getC1G2SingulationControl

public C1G2SingulationControl getC1G2SingulationControl()

get c1G2SingulationControl of type C1G2SingulationControl .

Returns:

C1G2SingulationControl

getCustomList

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

get customList of type List <Custom> .

Returns:

List <Custom>

addToC1G2FilterList

public void addToC1G2FilterList(C1G2Filter c1G2Filter)

add element c1G2Filter of type C1G2Filter .

Parameters:

c1G2Filter - of type C1G2Filter

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