org.llrp.ltk.generated.parameters
Class LLRPCapabilities

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

public class LLRPCapabilities
extends TLVParameter

This parameter describes the LLRP protocol capabilities of the Reader. These include optional LLRP commands and parameters, capacities of data structures used in LLRP operations, and air protocol specific capabilities used by LLRP.Readers MAY support RFSurvey, MAY support tag inventory state aware singulation, MAY support UTC clocks, MAY support buffer fill warning reports, MAY support EventAndReportHolding upon reconnect, and MAY support ClientRequestOpspec. Readers SHALL support at least one ROSpec, one AISpec per ROSpec, one InventoryParameterSpec per AISpec, one AccessSpec, and one OpSpec per AccessSpec. See also LLRP Specification Section 9.2.2 and LLRP Specification Section 16.2.3.2 .

Field Summary

protected Bit	canDoRFSurvey
protected Bit	canDoTagInventoryStateAwareSingulation
protected Bit	canReportBufferFillWarning
protected UnsignedShort	clientRequestOpSpecTimeout
protected UnsignedInteger	maxNumAccessSpecs
protected UnsignedInteger	maxNumInventoryParameterSpecsPerAISpec
protected UnsignedInteger	maxNumOpSpecsPerAccessSpec
protected UnsignedByte	maxNumPriorityLevelsSupported
protected UnsignedInteger	maxNumROSpecs
protected UnsignedInteger	maxNumSpecsPerROSpec
protected BitList	reserved0
protected Bit	supportsClientRequestOpSpec
protected Bit	supportsEventAndReportHolding
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

LLRPCapabilities()
empty constructor to create new parameter.

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

LLRPCapabilities(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.
Bit	getCanDoRFSurvey() get canDoRFSurvey of type Bit.
Bit	getCanDoTagInventoryStateAwareSingulation() get canDoTagInventoryStateAwareSingulation of type Bit.
Bit	getCanReportBufferFillWarning() get canReportBufferFillWarning of type Bit.
UnsignedShort	getClientRequestOpSpecTimeout() get clientRequestOpSpecTimeout of type UnsignedShort.
UnsignedInteger	getMaxNumAccessSpecs() get maxNumAccessSpecs of type UnsignedInteger.
UnsignedInteger	getMaxNumInventoryParameterSpecsPerAISpec() get maxNumInventoryParameterSpecsPerAISpec of type UnsignedInteger.
UnsignedInteger	getMaxNumOpSpecsPerAccessSpec() get maxNumOpSpecsPerAccessSpec of type UnsignedInteger.
UnsignedByte	getMaxNumPriorityLevelsSupported() get maxNumPriorityLevelsSupported of type UnsignedByte.
UnsignedInteger	getMaxNumROSpecs() get maxNumROSpecs of type UnsignedInteger.
UnsignedInteger	getMaxNumSpecsPerROSpec() get maxNumSpecsPerROSpec of type UnsignedInteger.
java.lang.String	getName() name of parameter (same as class name)
Bit	getSupportsClientRequestOpSpec() get supportsClientRequestOpSpec of type Bit.
Bit	getSupportsEventAndReportHolding() get supportsEventAndReportHolding 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	setCanDoRFSurvey(Bit canDoRFSurvey) set canDoRFSurvey of type Bit .
void	setCanDoTagInventoryStateAwareSingulation(Bit canDoTagInventoryStateAwareSingulation) set canDoTagInventoryStateAwareSingulation of type Bit .
void	setCanReportBufferFillWarning(Bit canReportBufferFillWarning) set canReportBufferFillWarning of type Bit .
void	setClientRequestOpSpecTimeout(UnsignedShort clientRequestOpSpecTimeout) set clientRequestOpSpecTimeout of type UnsignedShort .
void	setMaxNumAccessSpecs(UnsignedInteger maxNumAccessSpecs) set maxNumAccessSpecs of type UnsignedInteger .
void	setMaxNumInventoryParameterSpecsPerAISpec(UnsignedInteger maxNumInventoryParameterSpecsPerAISpec) set maxNumInventoryParameterSpecsPerAISpec of type UnsignedInteger .
void	setMaxNumOpSpecsPerAccessSpec(UnsignedInteger maxNumOpSpecsPerAccessSpec) set maxNumOpSpecsPerAccessSpec of type UnsignedInteger .
void	setMaxNumPriorityLevelsSupported(UnsignedByte maxNumPriorityLevelsSupported) set maxNumPriorityLevelsSupported of type UnsignedByte .
void	setMaxNumROSpecs(UnsignedInteger maxNumROSpecs) set maxNumROSpecs of type UnsignedInteger .
void	setMaxNumSpecsPerROSpec(UnsignedInteger maxNumSpecsPerROSpec) set maxNumSpecsPerROSpec of type UnsignedInteger .
void	setSupportsClientRequestOpSpec(Bit supportsClientRequestOpSpec) set supportsClientRequestOpSpec of type Bit .
void	setSupportsEventAndReportHolding(Bit supportsEventAndReportHolding) set supportsEventAndReportHolding 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

Field Detail

TYPENUM

public static final SignedShort TYPENUM

canDoRFSurvey

protected Bit canDoRFSurvey

canReportBufferFillWarning

protected Bit canReportBufferFillWarning

supportsClientRequestOpSpec

protected Bit supportsClientRequestOpSpec

canDoTagInventoryStateAwareSingulation

protected Bit canDoTagInventoryStateAwareSingulation

supportsEventAndReportHolding

protected Bit supportsEventAndReportHolding

reserved0

protected BitList reserved0

maxNumPriorityLevelsSupported

protected UnsignedByte maxNumPriorityLevelsSupported

clientRequestOpSpecTimeout

protected UnsignedShort clientRequestOpSpecTimeout

maxNumROSpecs

protected UnsignedInteger maxNumROSpecs

maxNumSpecsPerROSpec

protected UnsignedInteger maxNumSpecsPerROSpec

maxNumInventoryParameterSpecsPerAISpec

protected UnsignedInteger maxNumInventoryParameterSpecsPerAISpec

maxNumAccessSpecs

protected UnsignedInteger maxNumAccessSpecs

maxNumOpSpecsPerAccessSpec

protected UnsignedInteger maxNumOpSpecsPerAccessSpec

Constructor Detail

LLRPCapabilities

public LLRPCapabilities()

empty constructor to create new parameter.

LLRPCapabilities

public LLRPCapabilities(LLRPBitList list)

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

Parameters:

list - to be decoded

LLRPCapabilities

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

setCanDoRFSurvey

public void setCanDoRFSurvey(Bit canDoRFSurvey)

set canDoRFSurvey of type Bit .

Parameters:

canDoRFSurvey - to be set

setCanReportBufferFillWarning

public void setCanReportBufferFillWarning(Bit canReportBufferFillWarning)

set canReportBufferFillWarning of type Bit .

Parameters:

canReportBufferFillWarning - to be set

setSupportsClientRequestOpSpec

public void setSupportsClientRequestOpSpec(Bit supportsClientRequestOpSpec)

set supportsClientRequestOpSpec of type Bit .

Parameters:

supportsClientRequestOpSpec - to be set

setCanDoTagInventoryStateAwareSingulation

public void setCanDoTagInventoryStateAwareSingulation(Bit canDoTagInventoryStateAwareSingulation)

set canDoTagInventoryStateAwareSingulation of type Bit .

Parameters:

canDoTagInventoryStateAwareSingulation - to be set

setSupportsEventAndReportHolding

public void setSupportsEventAndReportHolding(Bit supportsEventAndReportHolding)

set supportsEventAndReportHolding of type Bit .

Parameters:

supportsEventAndReportHolding - to be set

setMaxNumPriorityLevelsSupported

public void setMaxNumPriorityLevelsSupported(UnsignedByte maxNumPriorityLevelsSupported)

set maxNumPriorityLevelsSupported of type UnsignedByte .

Parameters:

maxNumPriorityLevelsSupported - to be set

setClientRequestOpSpecTimeout

public void setClientRequestOpSpecTimeout(UnsignedShort clientRequestOpSpecTimeout)

set clientRequestOpSpecTimeout of type UnsignedShort .

Parameters:

clientRequestOpSpecTimeout - to be set

setMaxNumROSpecs

public void setMaxNumROSpecs(UnsignedInteger maxNumROSpecs)

set maxNumROSpecs of type UnsignedInteger .

Parameters:

maxNumROSpecs - to be set

setMaxNumSpecsPerROSpec

public void setMaxNumSpecsPerROSpec(UnsignedInteger maxNumSpecsPerROSpec)

set maxNumSpecsPerROSpec of type UnsignedInteger .

Parameters:

maxNumSpecsPerROSpec - to be set

setMaxNumInventoryParameterSpecsPerAISpec

public void setMaxNumInventoryParameterSpecsPerAISpec(UnsignedInteger maxNumInventoryParameterSpecsPerAISpec)

set maxNumInventoryParameterSpecsPerAISpec of type UnsignedInteger .

Parameters:

maxNumInventoryParameterSpecsPerAISpec - to be set

setMaxNumAccessSpecs

public void setMaxNumAccessSpecs(UnsignedInteger maxNumAccessSpecs)

set maxNumAccessSpecs of type UnsignedInteger .

Parameters:

maxNumAccessSpecs - to be set

setMaxNumOpSpecsPerAccessSpec

public void setMaxNumOpSpecsPerAccessSpec(UnsignedInteger maxNumOpSpecsPerAccessSpec)

set maxNumOpSpecsPerAccessSpec of type UnsignedInteger .

Parameters:

maxNumOpSpecsPerAccessSpec - to be set

getCanDoRFSurvey

public Bit getCanDoRFSurvey()

get canDoRFSurvey of type Bit.

Returns:

type Bit to be set

getCanReportBufferFillWarning

public Bit getCanReportBufferFillWarning()

get canReportBufferFillWarning of type Bit.

Returns:

type Bit to be set

getSupportsClientRequestOpSpec

public Bit getSupportsClientRequestOpSpec()

get supportsClientRequestOpSpec of type Bit.

Returns:

type Bit to be set

getCanDoTagInventoryStateAwareSingulation

public Bit getCanDoTagInventoryStateAwareSingulation()

get canDoTagInventoryStateAwareSingulation of type Bit.

Returns:

type Bit to be set

getSupportsEventAndReportHolding

public Bit getSupportsEventAndReportHolding()

get supportsEventAndReportHolding of type Bit.

Returns:

type Bit to be set

getMaxNumPriorityLevelsSupported

public UnsignedByte getMaxNumPriorityLevelsSupported()

get maxNumPriorityLevelsSupported of type UnsignedByte.

Returns:

type UnsignedByte to be set

getClientRequestOpSpecTimeout

public UnsignedShort getClientRequestOpSpecTimeout()

get clientRequestOpSpecTimeout of type UnsignedShort.

Returns:

type UnsignedShort to be set

getMaxNumROSpecs

public UnsignedInteger getMaxNumROSpecs()

get maxNumROSpecs of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getMaxNumSpecsPerROSpec

public UnsignedInteger getMaxNumSpecsPerROSpec()

get maxNumSpecsPerROSpec of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getMaxNumInventoryParameterSpecsPerAISpec

public UnsignedInteger getMaxNumInventoryParameterSpecsPerAISpec()

get maxNumInventoryParameterSpecsPerAISpec of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getMaxNumAccessSpecs

public UnsignedInteger getMaxNumAccessSpecs()

get maxNumAccessSpecs of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getMaxNumOpSpecsPerAccessSpec

public UnsignedInteger getMaxNumOpSpecsPerAccessSpec()

get maxNumOpSpecsPerAccessSpec of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

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