org.llrp.ltk.generated.parameters
Class FieldError

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

public class FieldError
extends TLVParameter

FieldNum: Field number for which the error applies. The fields are numbered after the order in which they appear in the parameter or message body. See also LLRP Specification Section 14.2.2.1 and LLRP Specification Section 16.2.8.1.1 .

Field Summary

protected StatusCode	errorCode
protected UnsignedShort	fieldNum
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

FieldError()
empty constructor to create new parameter.

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

FieldError(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.
StatusCode	getErrorCode() get errorCode of type StatusCode.
UnsignedShort	getFieldNum() get fieldNum of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
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	setErrorCode(StatusCode errorCode) set errorCode of type StatusCode .
void	setFieldNum(UnsignedShort fieldNum) set fieldNum 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

fieldNum

protected UnsignedShort fieldNum

errorCode

protected StatusCode errorCode

Constructor Detail

FieldError

public FieldError()

empty constructor to create new parameter.

FieldError

public FieldError(LLRPBitList list)

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

Parameters:

list - to be decoded

FieldError

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

setFieldNum

public void setFieldNum(UnsignedShort fieldNum)

set fieldNum of type UnsignedShort .

Parameters:

fieldNum - to be set

setErrorCode

public void setErrorCode(StatusCode errorCode)

set errorCode of type StatusCode .

Parameters:

errorCode - to be set

getFieldNum

public UnsignedShort getFieldNum()

get fieldNum of type UnsignedShort.

Returns:

type UnsignedShort to be set

getErrorCode

public StatusCode getErrorCode()

get errorCode of type StatusCode.

Returns:

StatusCode

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