org.llrp.ltk.generated.parameters
Class C1G2Filter

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

public class C1G2Filter
extends TLVParameter

This parameter carries information specific to C1G2 filter (in particular, the parameters for the select command) operation, and are optionally sent with each inventory command from the Client to the Reader. This sets up the target tag population that gets inventoried. For an inventory operation with multiple filters, multiple instances of filter parameters are sent. A filter parameter contains the following fields:Target tag mask: This contains the information for the tag memory data pattern used for the select operation.T: This value is set if the Client is interested in only a truncated portion of the tag to be backscattered by the tag. The portion that gets backscattered includes the portion of the tag ID following the mask. This bit has to be set only in the last filter-spec.TagInventoryStateAwareFilterAction: This is used if the TagInventoryStateAware flag is set to true in the InventoryParameterSpec. TagInventoryStateUnawareFilterAction: This is used if the TagInventoryStateAware flag is set to false in the InventoryParameterSpec. See also LLRP Specification Section 15.2.1.2.1.1 and LLRP Specification Section 16.3.1.2.1.1 .

Field Summary

protected C1G2TagInventoryMask	c1G2TagInventoryMask
protected C1G2TagInventoryStateAwareFilterAction	c1G2TagInventoryStateAwareFilterAction
protected C1G2TagInventoryStateUnawareFilterAction	c1G2TagInventoryStateUnawareFilterAction
protected BitList	reserved0
protected C1G2TruncateAction	t
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

C1G2Filter()
empty constructor to create new parameter.

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

C1G2Filter(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.
C1G2TagInventoryMask	getC1G2TagInventoryMask() get c1G2TagInventoryMask of type C1G2TagInventoryMask .
C1G2TagInventoryStateAwareFilterAction	getC1G2TagInventoryStateAwareFilterAction() get c1G2TagInventoryStateAwareFilterAction of type C1G2TagInventoryStateAwareFilterAction .
C1G2TagInventoryStateUnawareFilterAction	getC1G2TagInventoryStateUnawareFilterAction() get c1G2TagInventoryStateUnawareFilterAction of type C1G2TagInventoryStateUnawareFilterAction .
java.lang.String	getName() name of parameter (same as class name)
C1G2TruncateAction	getT() get t of type C1G2TruncateAction.
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	setC1G2TagInventoryMask(C1G2TagInventoryMask c1G2TagInventoryMask) set c1G2TagInventoryMask of type C1G2TagInventoryMask.
void	setC1G2TagInventoryStateAwareFilterAction(C1G2TagInventoryStateAwareFilterAction c1G2TagInventoryStateAwareFilterAction) set c1G2TagInventoryStateAwareFilterAction of type C1G2TagInventoryStateAwareFilterAction.
void	setC1G2TagInventoryStateUnawareFilterAction(C1G2TagInventoryStateUnawareFilterAction c1G2TagInventoryStateUnawareFilterAction) set c1G2TagInventoryStateUnawareFilterAction of type C1G2TagInventoryStateUnawareFilterAction.
void	setT(C1G2TruncateAction t) set t of type C1G2TruncateAction .
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

t

protected C1G2TruncateAction t

reserved0

protected BitList reserved0

c1G2TagInventoryMask

protected C1G2TagInventoryMask c1G2TagInventoryMask

c1G2TagInventoryStateAwareFilterAction

protected C1G2TagInventoryStateAwareFilterAction c1G2TagInventoryStateAwareFilterAction

c1G2TagInventoryStateUnawareFilterAction

protected C1G2TagInventoryStateUnawareFilterAction c1G2TagInventoryStateUnawareFilterAction

Constructor Detail

C1G2Filter

public C1G2Filter()

empty constructor to create new parameter.

C1G2Filter

public C1G2Filter(LLRPBitList list)

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

Parameters:

list - to be decoded

C1G2Filter

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

setT

public void setT(C1G2TruncateAction t)

set t of type C1G2TruncateAction .

Parameters:

t - to be set

setC1G2TagInventoryMask

public void setC1G2TagInventoryMask(C1G2TagInventoryMask c1G2TagInventoryMask)

set c1G2TagInventoryMask of type C1G2TagInventoryMask.

Parameters:

c1G2TagInventoryMask - to be set

setC1G2TagInventoryStateAwareFilterAction

public void setC1G2TagInventoryStateAwareFilterAction(C1G2TagInventoryStateAwareFilterAction c1G2TagInventoryStateAwareFilterAction)

set c1G2TagInventoryStateAwareFilterAction of type C1G2TagInventoryStateAwareFilterAction.

Parameters:

c1G2TagInventoryStateAwareFilterAction - to be set

setC1G2TagInventoryStateUnawareFilterAction

public void setC1G2TagInventoryStateUnawareFilterAction(C1G2TagInventoryStateUnawareFilterAction c1G2TagInventoryStateUnawareFilterAction)

set c1G2TagInventoryStateUnawareFilterAction of type C1G2TagInventoryStateUnawareFilterAction.

Parameters:

c1G2TagInventoryStateUnawareFilterAction - to be set

getT

public C1G2TruncateAction getT()

get t of type C1G2TruncateAction.

Returns:

C1G2TruncateAction

getC1G2TagInventoryMask

public C1G2TagInventoryMask getC1G2TagInventoryMask()

get c1G2TagInventoryMask of type C1G2TagInventoryMask .

Returns:

C1G2TagInventoryMask

getC1G2TagInventoryStateAwareFilterAction

public C1G2TagInventoryStateAwareFilterAction getC1G2TagInventoryStateAwareFilterAction()

get c1G2TagInventoryStateAwareFilterAction of type C1G2TagInventoryStateAwareFilterAction .

Returns:

C1G2TagInventoryStateAwareFilterAction

getC1G2TagInventoryStateUnawareFilterAction

public C1G2TagInventoryStateUnawareFilterAction getC1G2TagInventoryStateUnawareFilterAction()

get c1G2TagInventoryStateUnawareFilterAction of type C1G2TagInventoryStateUnawareFilterAction .

Returns:

C1G2TagInventoryStateUnawareFilterAction

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