org.llrp.ltk.generated.parameters
Class LLRPStatus

java.lang.Object
  extended by org.llrp.ltk.types.LLRPParameter
      extended by org.llrp.ltk.types.TLVParameter
          extended by org.llrp.ltk.generated.parameters.LLRPStatus

public class LLRPStatus
extends TLVParameter

See also LLRP Specification Section 14.2.2 and LLRP Specification Section 16.2.8.1 .


Field Summary
protected  UTF8String_UTF_8 errorDescription
           
protected  FieldError fieldError
           
protected  ParameterError parameterError
           
protected  StatusCode statusCode
           
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
LLRPStatus()
          empty constructor to create new parameter.
LLRPStatus(org.jdom.Element element)
          Constructor to create parameter from xml encoded parameter calls decodeXML to decode parameter.
LLRPStatus(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.
 UTF8String_UTF_8 getErrorDescription()
          get errorDescription of type UTF8String_UTF_8.
 FieldError getFieldError()
          get fieldError of type FieldError .
 java.lang.String getName()
          name of parameter (same as class name)
 ParameterError getParameterError()
          get parameterError of type ParameterError .
 StatusCode getStatusCode()
          get statusCode of type StatusCode.
 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 setErrorDescription(UTF8String_UTF_8 errorDescription)
          set errorDescription of type UTF8String_UTF_8 .
 void setFieldError(FieldError fieldError)
          set fieldError of type FieldError.
 void setParameterError(ParameterError parameterError)
          set parameterError of type ParameterError.
 void setStatusCode(StatusCode statusCode)
          set statusCode of type StatusCode .
 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

statusCode

protected StatusCode statusCode

errorDescription

protected UTF8String_UTF_8 errorDescription

fieldError

protected FieldError fieldError

parameterError

protected ParameterError parameterError
Constructor Detail

LLRPStatus

public LLRPStatus()
empty constructor to create new parameter.


LLRPStatus

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

Parameters:
list - to be decoded

LLRPStatus

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

setStatusCode

public void setStatusCode(StatusCode statusCode)
set statusCode of type StatusCode .

Parameters:
statusCode - to be set

setErrorDescription

public void setErrorDescription(UTF8String_UTF_8 errorDescription)
set errorDescription of type UTF8String_UTF_8 .

Parameters:
errorDescription - to be set

setFieldError

public void setFieldError(FieldError fieldError)
set fieldError of type FieldError.

Parameters:
fieldError - to be set

setParameterError

public void setParameterError(ParameterError parameterError)
set parameterError of type ParameterError.

Parameters:
parameterError - to be set

getStatusCode

public StatusCode getStatusCode()
get statusCode of type StatusCode.

Returns:
StatusCode

getErrorDescription

public UTF8String_UTF_8 getErrorDescription()
get errorDescription of type UTF8String_UTF_8.

Returns:
UTF8String_UTF_8

getFieldError

public FieldError getFieldError()
get fieldError of type FieldError .

Returns:
FieldError

getParameterError

public ParameterError getParameterError()
get parameterError of type ParameterError .

Returns:
ParameterError

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


Copyright © 2007 ETH Zurich.