org.llrp.ltk.generated.parameters
Class RFSurveyEvent

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

public class RFSurveyEvent
extends TLVParameter

ROSpecID: The identifier of the ROSpec that contains the RFSurveySpec. See also LLRP Specification Section 13.2.6.8 and LLRP Specification Section 16.2.7.6.7 .

Field Summary

protected RFSurveyEventType	eventType
protected UnsignedInteger	rOSpecID
protected UnsignedShort	specIndex
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

RFSurveyEvent()
empty constructor to create new parameter.

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

RFSurveyEvent(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.
RFSurveyEventType	getEventType() get eventType of type RFSurveyEventType.
java.lang.String	getName() name of parameter (same as class name)
UnsignedInteger	getROSpecID() get rOSpecID of type UnsignedInteger.
UnsignedShort	getSpecIndex() get specIndex of type UnsignedShort.
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	setEventType(RFSurveyEventType eventType) set eventType of type RFSurveyEventType .
void	setROSpecID(UnsignedInteger rOSpecID) set rOSpecID of type UnsignedInteger .
void	setSpecIndex(UnsignedShort specIndex) set specIndex of type UnsignedShort .
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

eventType

protected RFSurveyEventType eventType

rOSpecID

protected UnsignedInteger rOSpecID

specIndex

protected UnsignedShort specIndex

Constructor Detail

RFSurveyEvent

public RFSurveyEvent()

empty constructor to create new parameter.

RFSurveyEvent

public RFSurveyEvent(LLRPBitList list)

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

Parameters:

list - to be decoded

RFSurveyEvent

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

setEventType

public void setEventType(RFSurveyEventType eventType)

set eventType of type RFSurveyEventType .

Parameters:

eventType - to be set

setROSpecID

public void setROSpecID(UnsignedInteger rOSpecID)

set rOSpecID of type UnsignedInteger .

Parameters:

rOSpecID - to be set

setSpecIndex

public void setSpecIndex(UnsignedShort specIndex)

set specIndex of type UnsignedShort .

Parameters:

specIndex - to be set

getEventType

public RFSurveyEventType getEventType()

get eventType of type RFSurveyEventType.

Returns:

RFSurveyEventType

getROSpecID

public UnsignedInteger getROSpecID()

get rOSpecID of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getSpecIndex

public UnsignedShort getSpecIndex()

get specIndex of type UnsignedShort.

Returns:

type UnsignedShort 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