org.llrp.ltk.generated.parameters
Class C1G2SingulationControl

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

public class C1G2SingulationControl
extends TLVParameter

This C1G2SingulationControl Parameter provides controls particular to the singulation process in the C1G2 air protocol. The singulation process is started using a Query command in the C1G2 protocol. The Query command describes the session number, tag state, the start Q value to use, and the RF link parameters. The RF link parameters are specified using the C1G2RFControl Parameter (see section 15.2.1.2.1.2). This Singulation Parameter specifies the session, tag state and description of the target singulation environment. The following attributes are specified to provide guidance to the Reader for the singulation algorithm:Tag transit time: This is the measure of expected tag mobility in the field of view of the antenna where this inventory operation is getting executed.Tag population: This is the expected tag population in the field of view of the antenna. In addition, the Singulation Parameter allows setting of the following:Session ID: This is the C1G2 session number that the tags use to update the inventory state upon successful singulation.TagInventoryStateAwareSingulationAction: This is used if the TagInventoryStateAware flag is set to true in the InventoryParameterSpec. I: This is the inventoried state of the target tag population in the selected session. Only tags that match the session state participate in the inventory round. If the Ignore value is specified, the Reader ignores this field, and its up to the Reader implementation to determine the value of I used in the inventory round. S: This is the state of the SL flag in the tag. Only tags that match that tag state participate in the inventory round. If the Ignore value is specified, the Reader ignores this field, and its up to the Reader implementation to determine the value of S used in the inventory round. If a reader sets CanDoTagInventoryStateAwareSingulation to False in LLRPCapabilities (section 9.2.2), it SHALL ignore the TagInventoryStateAwareSingulationAction field. See also LLRP Specification Section 15.2.1.2.1.3 and LLRP Specification Section 16.3.1.2.1.3 .

Field Summary

protected C1G2TagInventoryStateAwareSingulationAction	c1G2TagInventoryStateAwareSingulationAction
protected BitList	reserved0
protected TwoBitField	session
protected UnsignedShort	tagPopulation
protected UnsignedInteger	tagTransitTime
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

C1G2SingulationControl()
empty constructor to create new parameter.

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

C1G2SingulationControl(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.
C1G2TagInventoryStateAwareSingulationAction	getC1G2TagInventoryStateAwareSingulationAction() get c1G2TagInventoryStateAwareSingulationAction of type C1G2TagInventoryStateAwareSingulationAction .
java.lang.String	getName() name of parameter (same as class name)
TwoBitField	getSession() get session of type TwoBitField.
UnsignedShort	getTagPopulation() get tagPopulation of type UnsignedShort.
UnsignedInteger	getTagTransitTime() get tagTransitTime of type UnsignedInteger.
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	setC1G2TagInventoryStateAwareSingulationAction(C1G2TagInventoryStateAwareSingulationAction c1G2TagInventoryStateAwareSingulationAction) set c1G2TagInventoryStateAwareSingulationAction of type C1G2TagInventoryStateAwareSingulationAction.
void	setSession(TwoBitField session) set session of type TwoBitField .
void	setTagPopulation(UnsignedShort tagPopulation) set tagPopulation of type UnsignedShort .
void	setTagTransitTime(UnsignedInteger tagTransitTime) set tagTransitTime of type UnsignedInteger .
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

session

protected TwoBitField session

reserved0

protected BitList reserved0

tagPopulation

protected UnsignedShort tagPopulation

tagTransitTime

protected UnsignedInteger tagTransitTime

c1G2TagInventoryStateAwareSingulationAction

protected C1G2TagInventoryStateAwareSingulationAction c1G2TagInventoryStateAwareSingulationAction

Constructor Detail

C1G2SingulationControl

public C1G2SingulationControl()

empty constructor to create new parameter.

C1G2SingulationControl

public C1G2SingulationControl(LLRPBitList list)

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

Parameters:

list - to be decoded

C1G2SingulationControl

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

setSession

public void setSession(TwoBitField session)

set session of type TwoBitField .

Parameters:

session - to be set

setTagPopulation

public void setTagPopulation(UnsignedShort tagPopulation)

set tagPopulation of type UnsignedShort .

Parameters:

tagPopulation - to be set

setTagTransitTime

public void setTagTransitTime(UnsignedInteger tagTransitTime)

set tagTransitTime of type UnsignedInteger .

Parameters:

tagTransitTime - to be set

setC1G2TagInventoryStateAwareSingulationAction

public void setC1G2TagInventoryStateAwareSingulationAction(C1G2TagInventoryStateAwareSingulationAction c1G2TagInventoryStateAwareSingulationAction)

set c1G2TagInventoryStateAwareSingulationAction of type C1G2TagInventoryStateAwareSingulationAction.

Parameters:

c1G2TagInventoryStateAwareSingulationAction - to be set

getSession

public TwoBitField getSession()

get session of type TwoBitField.

Returns:

type TwoBitField to be set

getTagPopulation

public UnsignedShort getTagPopulation()

get tagPopulation of type UnsignedShort.

Returns:

type UnsignedShort to be set

getTagTransitTime

public UnsignedInteger getTagTransitTime()

get tagTransitTime of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getC1G2TagInventoryStateAwareSingulationAction

public C1G2TagInventoryStateAwareSingulationAction getC1G2TagInventoryStateAwareSingulationAction()

get c1G2TagInventoryStateAwareSingulationAction of type C1G2TagInventoryStateAwareSingulationAction .

Returns:

C1G2TagInventoryStateAwareSingulationAction

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