org.llrp.ltk.generated.parameters
Class ROSpec

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

public class ROSpec
extends TLVParameter

This parameter carries the information of the Reader inventory and survey operation. See also LLRP Specification Section 10.2.1 and LLRP Specification Section 16.2.4.1 .

Field Summary

protected ROSpecState	currentState
protected UnsignedByte	priority
protected ROBoundarySpec	rOBoundarySpec
protected ROReportSpec	rOReportSpec
protected UnsignedInteger	rOSpecID
protected java.util.List<SpecParameter>	specParameterList
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

ROSpec()
empty constructor to create new parameter.

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

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

Method Summary

void	addToSpecParameterList(SpecParameter specParameter) add element specParameter of type SpecParameter .
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.
ROSpecState	getCurrentState() get currentState of type ROSpecState.
java.lang.String	getName() name of parameter (same as class name)
UnsignedByte	getPriority() get priority of type UnsignedByte.
ROBoundarySpec	getROBoundarySpec() get rOBoundarySpec of type ROBoundarySpec .
ROReportSpec	getROReportSpec() get rOReportSpec of type ROReportSpec .
UnsignedInteger	getROSpecID() get rOSpecID of type UnsignedInteger.
java.util.List<SpecParameter>	getSpecParameterList() get specParameterList of type List <SpecParameter> .
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	setCurrentState(ROSpecState currentState) set currentState of type ROSpecState .
void	setPriority(UnsignedByte priority) set priority of type UnsignedByte .
void	setROBoundarySpec(ROBoundarySpec rOBoundarySpec) set rOBoundarySpec of type ROBoundarySpec.
void	setROReportSpec(ROReportSpec rOReportSpec) set rOReportSpec of type ROReportSpec.
void	setROSpecID(UnsignedInteger rOSpecID) set rOSpecID of type UnsignedInteger .
void	setSpecParameterList(java.util.List<SpecParameter> specParameterList) set specParameterList of type List <SpecParameter>.
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

rOSpecID

protected UnsignedInteger rOSpecID

priority

protected UnsignedByte priority

currentState

protected ROSpecState currentState

rOBoundarySpec

protected ROBoundarySpec rOBoundarySpec

specParameterList

protected java.util.List<SpecParameter> specParameterList

rOReportSpec

protected ROReportSpec rOReportSpec

Constructor Detail

ROSpec

public ROSpec()

empty constructor to create new parameter.

ROSpec

public ROSpec(LLRPBitList list)

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

Parameters:

list - to be decoded

ROSpec

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

setROSpecID

public void setROSpecID(UnsignedInteger rOSpecID)

set rOSpecID of type UnsignedInteger .

Parameters:

rOSpecID - to be set

setPriority

public void setPriority(UnsignedByte priority)

set priority of type UnsignedByte .

Parameters:

priority - to be set

setCurrentState

public void setCurrentState(ROSpecState currentState)

set currentState of type ROSpecState .

Parameters:

currentState - to be set

setROBoundarySpec

public void setROBoundarySpec(ROBoundarySpec rOBoundarySpec)

set rOBoundarySpec of type ROBoundarySpec.

Parameters:

rOBoundarySpec - to be set

setSpecParameterList

public void setSpecParameterList(java.util.List<SpecParameter> specParameterList)

set specParameterList of type List <SpecParameter>.

Parameters:

specParameterList - to be set

setROReportSpec

public void setROReportSpec(ROReportSpec rOReportSpec)

set rOReportSpec of type ROReportSpec.

Parameters:

rOReportSpec - to be set

getROSpecID

public UnsignedInteger getROSpecID()

get rOSpecID of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getPriority

public UnsignedByte getPriority()

get priority of type UnsignedByte.

Returns:

type UnsignedByte to be set

getCurrentState

public ROSpecState getCurrentState()

get currentState of type ROSpecState.

Returns:

ROSpecState

getROBoundarySpec

public ROBoundarySpec getROBoundarySpec()

get rOBoundarySpec of type ROBoundarySpec .

Returns:

ROBoundarySpec

getSpecParameterList

public java.util.List<SpecParameter> getSpecParameterList()

get specParameterList of type List <SpecParameter> .

Returns:

List <SpecParameter>

getROReportSpec

public ROReportSpec getROReportSpec()

get rOReportSpec of type ROReportSpec .

Returns:

ROReportSpec

addToSpecParameterList

public void addToSpecParameterList(SpecParameter specParameter)

add element specParameter of type SpecParameter .

Parameters:

specParameter - of type SpecParameter

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