org.llrp.ltk.generated.parameters
Class C1G2WriteOpSpecResult

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

All Implemented Interfaces:

AccessCommandOpSpecResult

public class C1G2WriteOpSpecResult
extends TLVParameter
implements AccessCommandOpSpecResult

Contains the result from a write operation.If the number of words written is not equal to the length of the data pattern to write, the Result SHALL be non-zero. See also LLRP Specification Section 15.2.1.5.5.2 and LLRP Specification Section 16.3.1.5.5.2 .

Field Summary

protected UnsignedShort	numWordsWritten
protected UnsignedShort	opSpecID
protected C1G2WriteResultType	result
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

C1G2WriteOpSpecResult()
empty constructor to create new parameter.

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

C1G2WriteOpSpecResult(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.
java.lang.String	getName() name of parameter (same as class name)
UnsignedShort	getNumWordsWritten() get numWordsWritten of type UnsignedShort.
UnsignedShort	getOpSpecID() get opSpecID of type UnsignedShort.
C1G2WriteResultType	getResult() get result of type C1G2WriteResultType.
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	setNumWordsWritten(UnsignedShort numWordsWritten) set numWordsWritten of type UnsignedShort .
void	setOpSpecID(UnsignedShort opSpecID) set opSpecID of type UnsignedShort .
void	setResult(C1G2WriteResultType result) set result of type C1G2WriteResultType .
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

Methods inherited from interface org.llrp.ltk.generated.interfaces.AccessCommandOpSpecResult

decodeBinary, encodeBinary

Field Detail

TYPENUM

public static final SignedShort TYPENUM

result

protected C1G2WriteResultType result

opSpecID

protected UnsignedShort opSpecID

numWordsWritten

protected UnsignedShort numWordsWritten

Constructor Detail

C1G2WriteOpSpecResult

public C1G2WriteOpSpecResult()

empty constructor to create new parameter.

C1G2WriteOpSpecResult

public C1G2WriteOpSpecResult(LLRPBitList list)

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

Parameters:

list - to be decoded

C1G2WriteOpSpecResult

public C1G2WriteOpSpecResult(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 interface AccessCommandOpSpecResult

Specified by:

encodeXML in class LLRPParameter

Parameters:

name - of element

ns - Namespace of elements

Returns:

JDom Content object

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 interface AccessCommandOpSpecResult

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setResult

public void setResult(C1G2WriteResultType result)

set result of type C1G2WriteResultType .

Parameters:

result - to be set

setOpSpecID

public void setOpSpecID(UnsignedShort opSpecID)

set opSpecID of type UnsignedShort .

Parameters:

opSpecID - to be set

setNumWordsWritten

public void setNumWordsWritten(UnsignedShort numWordsWritten)

set numWordsWritten of type UnsignedShort .

Parameters:

numWordsWritten - to be set

getResult

public C1G2WriteResultType getResult()

get result of type C1G2WriteResultType.

Returns:

C1G2WriteResultType

getOpSpecID

public UnsignedShort getOpSpecID()

get opSpecID of type UnsignedShort.

Returns:

type UnsignedShort to be set

getNumWordsWritten

public UnsignedShort getNumWordsWritten()

get numWordsWritten 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