org.llrp.ltk.generated.parameters
Class ROReportSpec

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

public class ROReportSpec
extends TLVParameter

This Parameter carries the Reader inventory and RF survey reporting definition for the antenna. This parameter describes the contents of the report sent by the Reader and defines the events that cause the report to be sent.The ROReportTrigger field defines the events that cause the report to be sent.The TagReportContentSelector parameter defines the desired contents of the report. The ROReportTrigger defines the event that causes the report to be sent by the Reader to the Client.See section 13.2.6.1 for details about the order that reports are to be sent with respect to Reader event notifications. See also LLRP Specification Section 13.2.1 and LLRP Specification Section 16.2.7.1 .

Field Summary

protected java.util.List<Custom>	customList
protected UnsignedShort	n
protected ROReportTriggerType	rOReportTrigger
protected TagReportContentSelector	tagReportContentSelector
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

ROReportSpec()
empty constructor to create new parameter.

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

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

Method Summary

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<Custom>	getCustomList() get customList of type List <Custom> .
UnsignedShort	getN() get n of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
ROReportTriggerType	getROReportTrigger() get rOReportTrigger of type ROReportTriggerType.
TagReportContentSelector	getTagReportContentSelector() get tagReportContentSelector of type TagReportContentSelector .
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	setCustomList(java.util.List<Custom> customList) set customList of type List <Custom>.
void	setN(UnsignedShort n) set n of type UnsignedShort .
void	setROReportTrigger(ROReportTriggerType rOReportTrigger) set rOReportTrigger of type ROReportTriggerType .
void	setTagReportContentSelector(TagReportContentSelector tagReportContentSelector) set tagReportContentSelector of type TagReportContentSelector.
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

rOReportTrigger

protected ROReportTriggerType rOReportTrigger

n

protected UnsignedShort n

tagReportContentSelector

protected TagReportContentSelector tagReportContentSelector

customList

protected java.util.List<Custom> customList

Constructor Detail

ROReportSpec

public ROReportSpec()

empty constructor to create new parameter.

ROReportSpec

public ROReportSpec(LLRPBitList list)

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

Parameters:

list - to be decoded

ROReportSpec

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

setROReportTrigger

public void setROReportTrigger(ROReportTriggerType rOReportTrigger)

set rOReportTrigger of type ROReportTriggerType .

Parameters:

rOReportTrigger - to be set

setN

public void setN(UnsignedShort n)

set n of type UnsignedShort .

Parameters:

n - to be set

setTagReportContentSelector

public void setTagReportContentSelector(TagReportContentSelector tagReportContentSelector)

set tagReportContentSelector of type TagReportContentSelector.

Parameters:

tagReportContentSelector - to be set

setCustomList

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

set customList of type List <Custom>.

Parameters:

customList - to be set

getROReportTrigger

public ROReportTriggerType getROReportTrigger()

get rOReportTrigger of type ROReportTriggerType.

Returns:

ROReportTriggerType

getN

public UnsignedShort getN()

get n of type UnsignedShort.

Returns:

type UnsignedShort to be set

getTagReportContentSelector

public TagReportContentSelector getTagReportContentSelector()

get tagReportContentSelector of type TagReportContentSelector .

Returns:

TagReportContentSelector

getCustomList

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

get customList of type List <Custom> .

Returns:

List <Custom>

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