org.llrp.ltk.generated.parameters
Class TagReportData

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

public class TagReportData
extends TLVParameter

This report parameter is generated per tag per accumulation scope. The only mandatory portion of this parameter is the EPCData parameter. If there was an access operation performed on the tag, the results of the OpSpecs are mandatory in the report. The other sub-parameters in this report are optional. LLRP provides three ways to make the tag reporting efficient:Allow parameters to be enabled or disabled via TagReportContentSelector (section 13.2.1.1) in TagReportSpec. If an optional parameter is enabled, and is absent in the report, the Client SHALL assume that the value is identical to the last parameter of the same type received. For example, this allows the Readers to not send a parameter in the report whose value has not changed since the last time it was sent by the Reader.Allow accumulation of tag reports. See next section for details of accumulation. A Reader MAY accumulate multiple tag reports into a single tag report.. If a Reader accumulates, the Reader SHALL follow the accumulation rules specified in this section. The following specifies the rules for accumulating multiple tag observations into a single TagReportData:EPCData:The Reader SHALL not accumulate tag reports that do not have the same EPCData value.OpSpecResultList:The Reader SHALL not accumulate tag reports that do not have the same value for the OpSpec results in the OpSpecResultList.SpecID, SpecIndex, InventoryParameterSpecID, AntennaID, AirProtocolTagData, AccessSpecID:These fields are optional, and their reporting can be enabled by the Client. If the Client has enabled one or more fields listed above, the Reader SHALL not accumulate tag reports that do not have the same value for all the enabled fields.FirstSeenTimestamp, LastSeenTimestamp, PeakRSSI, TagSeenCount, ChannelIndexThese fields are optional, and their reporting can be enabled by the Client. If the field is enabled, the Reader sets the value of these fields as follows:FirstSeenTimestamp: The Reader SHALL set it to the time of the first observation amongst the tag reports that get accumulated in the TagReportData.LastSeenTimestamp: The Reader SHALL set it to the time of the last observation amongst the tag reports that get accumulated in the TagReportData.PeakRSSI: The Reader SHALL set it to the maximum RSSI value observed amongst the tag reports that get accumulated in the TagReportData.ChannelIndex: The Reader MAY set it to the index of the first channel the tag was seen.TagSeenCount: The Reader SHALL set it to the number of tag reports that get accumulated in the TagReportData. See also LLRP Specification Section 13.2.3 and LLRP Specification Section 16.2.7.3 .

Field Summary

protected java.util.List<AccessCommandOpSpecResult>	accessCommandOpSpecResultList
protected AccessSpecID	accessSpecID
protected java.util.List<AirProtocolTagData>	airProtocolTagDataList
protected AntennaID	antennaID
protected ChannelIndex	channelIndex
protected java.util.List<Custom>	customList
protected EPCParameter	ePCParameter
protected FirstSeenTimestampUptime	firstSeenTimestampUptime
protected FirstSeenTimestampUTC	firstSeenTimestampUTC
protected InventoryParameterSpecID	inventoryParameterSpecID
protected LastSeenTimestampUptime	lastSeenTimestampUptime
protected LastSeenTimestampUTC	lastSeenTimestampUTC
protected PeakRSSI	peakRSSI
protected ROSpecID	rOSpecID
protected SpecIndex	specIndex
protected TagSeenCount	tagSeenCount
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

TagReportData()
empty constructor to create new parameter.

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

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

Method Summary

void	addToAccessCommandOpSpecResultList(AccessCommandOpSpecResult accessCommandOpSpecResult) add element accessCommandOpSpecResult of type AccessCommandOpSpecResult .
void	addToAirProtocolTagDataList(AirProtocolTagData airProtocolTagData) add element airProtocolTagData of type AirProtocolTagData .
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<AccessCommandOpSpecResult>	getAccessCommandOpSpecResultList() get accessCommandOpSpecResultList of type List <AccessCommandOpSpecResult> .
AccessSpecID	getAccessSpecID() get accessSpecID of type AccessSpecID .
java.util.List<AirProtocolTagData>	getAirProtocolTagDataList() get airProtocolTagDataList of type List <AirProtocolTagData> .
AntennaID	getAntennaID() get antennaID of type AntennaID .
ChannelIndex	getChannelIndex() get channelIndex of type ChannelIndex .
java.util.List<Custom>	getCustomList() get customList of type List <Custom> .
EPCParameter	getEPCParameter() get ePCParameter of type EPCParameter .
FirstSeenTimestampUptime	getFirstSeenTimestampUptime() get firstSeenTimestampUptime of type FirstSeenTimestampUptime .
FirstSeenTimestampUTC	getFirstSeenTimestampUTC() get firstSeenTimestampUTC of type FirstSeenTimestampUTC .
InventoryParameterSpecID	getInventoryParameterSpecID() get inventoryParameterSpecID of type InventoryParameterSpecID .
LastSeenTimestampUptime	getLastSeenTimestampUptime() get lastSeenTimestampUptime of type LastSeenTimestampUptime .
LastSeenTimestampUTC	getLastSeenTimestampUTC() get lastSeenTimestampUTC of type LastSeenTimestampUTC .
java.lang.String	getName() name of parameter (same as class name)
PeakRSSI	getPeakRSSI() get peakRSSI of type PeakRSSI .
ROSpecID	getROSpecID() get rOSpecID of type ROSpecID .
SpecIndex	getSpecIndex() get specIndex of type SpecIndex .
TagSeenCount	getTagSeenCount() get tagSeenCount of type TagSeenCount .
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	setAccessCommandOpSpecResultList(java.util.List<AccessCommandOpSpecResult> accessCommandOpSpecResultList) set accessCommandOpSpecResultList of type List <AccessCommandOpSpecResult>.
void	setAccessSpecID(AccessSpecID accessSpecID) set accessSpecID of type AccessSpecID.
void	setAirProtocolTagDataList(java.util.List<AirProtocolTagData> airProtocolTagDataList) set airProtocolTagDataList of type List <AirProtocolTagData>.
void	setAntennaID(AntennaID antennaID) set antennaID of type AntennaID.
void	setChannelIndex(ChannelIndex channelIndex) set channelIndex of type ChannelIndex.
void	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setEPCParameter(EPCParameter ePCParameter) set ePCParameter of type EPCParameter.
void	setFirstSeenTimestampUptime(FirstSeenTimestampUptime firstSeenTimestampUptime) set firstSeenTimestampUptime of type FirstSeenTimestampUptime.
void	setFirstSeenTimestampUTC(FirstSeenTimestampUTC firstSeenTimestampUTC) set firstSeenTimestampUTC of type FirstSeenTimestampUTC.
void	setInventoryParameterSpecID(InventoryParameterSpecID inventoryParameterSpecID) set inventoryParameterSpecID of type InventoryParameterSpecID.
void	setLastSeenTimestampUptime(LastSeenTimestampUptime lastSeenTimestampUptime) set lastSeenTimestampUptime of type LastSeenTimestampUptime.
void	setLastSeenTimestampUTC(LastSeenTimestampUTC lastSeenTimestampUTC) set lastSeenTimestampUTC of type LastSeenTimestampUTC.
void	setPeakRSSI(PeakRSSI peakRSSI) set peakRSSI of type PeakRSSI.
void	setROSpecID(ROSpecID rOSpecID) set rOSpecID of type ROSpecID.
void	setSpecIndex(SpecIndex specIndex) set specIndex of type SpecIndex.
void	setTagSeenCount(TagSeenCount tagSeenCount) set tagSeenCount of type TagSeenCount.
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

ePCParameter

protected EPCParameter ePCParameter

rOSpecID

protected ROSpecID rOSpecID

specIndex

protected SpecIndex specIndex

inventoryParameterSpecID

protected InventoryParameterSpecID inventoryParameterSpecID

antennaID

protected AntennaID antennaID

peakRSSI

protected PeakRSSI peakRSSI

channelIndex

protected ChannelIndex channelIndex

firstSeenTimestampUTC

protected FirstSeenTimestampUTC firstSeenTimestampUTC

firstSeenTimestampUptime

protected FirstSeenTimestampUptime firstSeenTimestampUptime

lastSeenTimestampUTC

protected LastSeenTimestampUTC lastSeenTimestampUTC

lastSeenTimestampUptime

protected LastSeenTimestampUptime lastSeenTimestampUptime

tagSeenCount

protected TagSeenCount tagSeenCount

airProtocolTagDataList

protected java.util.List<AirProtocolTagData> airProtocolTagDataList

accessSpecID

protected AccessSpecID accessSpecID

accessCommandOpSpecResultList

protected java.util.List<AccessCommandOpSpecResult> accessCommandOpSpecResultList

customList

protected java.util.List<Custom> customList

Constructor Detail

TagReportData

public TagReportData()

empty constructor to create new parameter.

TagReportData

public TagReportData(LLRPBitList list)

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

Parameters:

list - to be decoded

TagReportData

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

setEPCParameter

public void setEPCParameter(EPCParameter ePCParameter)

set ePCParameter of type EPCParameter.

Parameters:

ePCParameter - to be set

setROSpecID

public void setROSpecID(ROSpecID rOSpecID)

set rOSpecID of type ROSpecID.

Parameters:

rOSpecID - to be set

setSpecIndex

public void setSpecIndex(SpecIndex specIndex)

set specIndex of type SpecIndex.

Parameters:

specIndex - to be set

setInventoryParameterSpecID

public void setInventoryParameterSpecID(InventoryParameterSpecID inventoryParameterSpecID)

set inventoryParameterSpecID of type InventoryParameterSpecID.

Parameters:

inventoryParameterSpecID - to be set

setAntennaID

public void setAntennaID(AntennaID antennaID)

set antennaID of type AntennaID.

Parameters:

antennaID - to be set

setPeakRSSI

public void setPeakRSSI(PeakRSSI peakRSSI)

set peakRSSI of type PeakRSSI.

Parameters:

peakRSSI - to be set

setChannelIndex

public void setChannelIndex(ChannelIndex channelIndex)

set channelIndex of type ChannelIndex.

Parameters:

channelIndex - to be set

setFirstSeenTimestampUTC

public void setFirstSeenTimestampUTC(FirstSeenTimestampUTC firstSeenTimestampUTC)

set firstSeenTimestampUTC of type FirstSeenTimestampUTC.

Parameters:

firstSeenTimestampUTC - to be set

setFirstSeenTimestampUptime

public void setFirstSeenTimestampUptime(FirstSeenTimestampUptime firstSeenTimestampUptime)

set firstSeenTimestampUptime of type FirstSeenTimestampUptime.

Parameters:

firstSeenTimestampUptime - to be set

setLastSeenTimestampUTC

public void setLastSeenTimestampUTC(LastSeenTimestampUTC lastSeenTimestampUTC)

set lastSeenTimestampUTC of type LastSeenTimestampUTC.

Parameters:

lastSeenTimestampUTC - to be set

setLastSeenTimestampUptime

public void setLastSeenTimestampUptime(LastSeenTimestampUptime lastSeenTimestampUptime)

set lastSeenTimestampUptime of type LastSeenTimestampUptime.

Parameters:

lastSeenTimestampUptime - to be set

setTagSeenCount

public void setTagSeenCount(TagSeenCount tagSeenCount)

set tagSeenCount of type TagSeenCount.

Parameters:

tagSeenCount - to be set

setAirProtocolTagDataList

public void setAirProtocolTagDataList(java.util.List<AirProtocolTagData> airProtocolTagDataList)

set airProtocolTagDataList of type List <AirProtocolTagData>.

Parameters:

airProtocolTagDataList - to be set

setAccessSpecID

public void setAccessSpecID(AccessSpecID accessSpecID)

set accessSpecID of type AccessSpecID.

Parameters:

accessSpecID - to be set

setAccessCommandOpSpecResultList

public void setAccessCommandOpSpecResultList(java.util.List<AccessCommandOpSpecResult> accessCommandOpSpecResultList)

set accessCommandOpSpecResultList of type List <AccessCommandOpSpecResult>.

Parameters:

accessCommandOpSpecResultList - to be set

setCustomList

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

set customList of type List <Custom>.

Parameters:

customList - to be set

getEPCParameter

public EPCParameter getEPCParameter()

get ePCParameter of type EPCParameter .

Returns:

EPCParameter

getROSpecID

public ROSpecID getROSpecID()

get rOSpecID of type ROSpecID .

Returns:

ROSpecID

getSpecIndex

public SpecIndex getSpecIndex()

get specIndex of type SpecIndex .

Returns:

SpecIndex

getInventoryParameterSpecID

public InventoryParameterSpecID getInventoryParameterSpecID()

get inventoryParameterSpecID of type InventoryParameterSpecID .

Returns:

InventoryParameterSpecID

getAntennaID

public AntennaID getAntennaID()

get antennaID of type AntennaID .

Returns:

AntennaID

getPeakRSSI

public PeakRSSI getPeakRSSI()

get peakRSSI of type PeakRSSI .

Returns:

PeakRSSI

getChannelIndex

public ChannelIndex getChannelIndex()

get channelIndex of type ChannelIndex .

Returns:

ChannelIndex

getFirstSeenTimestampUTC

public FirstSeenTimestampUTC getFirstSeenTimestampUTC()

get firstSeenTimestampUTC of type FirstSeenTimestampUTC .

Returns:

FirstSeenTimestampUTC

getFirstSeenTimestampUptime

public FirstSeenTimestampUptime getFirstSeenTimestampUptime()

get firstSeenTimestampUptime of type FirstSeenTimestampUptime .

Returns:

FirstSeenTimestampUptime

getLastSeenTimestampUTC

public LastSeenTimestampUTC getLastSeenTimestampUTC()

get lastSeenTimestampUTC of type LastSeenTimestampUTC .

Returns:

LastSeenTimestampUTC

getLastSeenTimestampUptime

public LastSeenTimestampUptime getLastSeenTimestampUptime()

get lastSeenTimestampUptime of type LastSeenTimestampUptime .

Returns:

LastSeenTimestampUptime

getTagSeenCount

public TagSeenCount getTagSeenCount()

get tagSeenCount of type TagSeenCount .

Returns:

TagSeenCount

getAirProtocolTagDataList

public java.util.List<AirProtocolTagData> getAirProtocolTagDataList()

get airProtocolTagDataList of type List <AirProtocolTagData> .

Returns:

List <AirProtocolTagData>

getAccessSpecID

public AccessSpecID getAccessSpecID()

get accessSpecID of type AccessSpecID .

Returns:

AccessSpecID

getAccessCommandOpSpecResultList

public java.util.List<AccessCommandOpSpecResult> getAccessCommandOpSpecResultList()

get accessCommandOpSpecResultList of type List <AccessCommandOpSpecResult> .

Returns:

List <AccessCommandOpSpecResult>

getCustomList

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

get customList of type List <Custom> .

Returns:

List <Custom>

addToAirProtocolTagDataList

public void addToAirProtocolTagDataList(AirProtocolTagData airProtocolTagData)

add element airProtocolTagData of type AirProtocolTagData .

Parameters:

airProtocolTagData - of type AirProtocolTagData

addToAccessCommandOpSpecResultList

public void addToAccessCommandOpSpecResultList(AccessCommandOpSpecResult accessCommandOpSpecResult)

add element accessCommandOpSpecResult of type AccessCommandOpSpecResult .

Parameters:

accessCommandOpSpecResult - of type AccessCommandOpSpecResult

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