org.llrp.ltk.generated.parameters
Class Custom

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

All Implemented Interfaces:

SpecParameter

public class Custom
extends TLVParameter
implements SpecParameter

Certain Messages and Parameter Sets within LLRP allow for the insertion of vendor defined parametersClients SHALL accept messages (except for CUSTOM_MESSAGE) that contain custom parameters but MAY ignore all custom parameters within these messages. Readers SHALL accept messages (except for CUSTOM_MESSAGE) that contain custom parameters and SHALL return an error when such parameters are unsupported. See also LLRP Specification Section 8.2 and LLRP Specification Section 16.2.9 .

Field Summary

protected BytesToEnd_HEX	data
protected UnsignedInteger	parameterSubtype
static SignedShort	TYPENUM
protected UnsignedInteger	vendorIdentifier

Fields inherited from class org.llrp.ltk.types.TLVParameter

RESERVEDLENGTH, TYPENUMBERLENGTH

Fields inherited from class org.llrp.ltk.types.LLRPParameter

bitLength

Constructor Summary

Custom()
empty constructor to create new parameter.

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

Custom(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.
BytesToEnd_HEX	getData() get data of type BytesToEnd_HEX.
java.lang.String	getName() name of parameter (same as class name)
UnsignedInteger	getParameterSubtype() get parameterSubtype of type UnsignedInteger.
SignedShort	getTypeNum() type number uniquely identifies a parameter.
UnsignedInteger	getVendorIdentifier() get vendorIdentifier of type UnsignedInteger.
static java.lang.Integer	length() For TLV Parameter length can not be determined at compile time.
void	setData(BytesToEnd_HEX data) set data of type BytesToEnd_HEX .
void	setParameterSubtype(UnsignedInteger parameterSubtype) set parameterSubtype of type UnsignedInteger .
void	setVendorIdentifier(UnsignedInteger vendorIdentifier) set vendorIdentifier of type UnsignedInteger .
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.SpecParameter

decodeBinary, encodeBinary

Field Detail

TYPENUM

public static final SignedShort TYPENUM

vendorIdentifier

protected UnsignedInteger vendorIdentifier

parameterSubtype

protected UnsignedInteger parameterSubtype

data

protected BytesToEnd_HEX data

Constructor Detail

Custom

public Custom()

empty constructor to create new parameter.

Custom

public Custom(LLRPBitList list)

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

Parameters:

list - to be decoded

Custom

public Custom(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 SpecParameter

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 SpecParameter

Specified by:

decodeXML in class LLRPParameter

Parameters:

element - to be decoded

Throws:

InvalidLLRPMessageException

setVendorIdentifier

public void setVendorIdentifier(UnsignedInteger vendorIdentifier)

set vendorIdentifier of type UnsignedInteger .

Parameters:

vendorIdentifier - to be set

setParameterSubtype

public void setParameterSubtype(UnsignedInteger parameterSubtype)

set parameterSubtype of type UnsignedInteger .

Parameters:

parameterSubtype - to be set

setData

public void setData(BytesToEnd_HEX data)

set data of type BytesToEnd_HEX .

Parameters:

data - to be set

getVendorIdentifier

public UnsignedInteger getVendorIdentifier()

get vendorIdentifier of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getParameterSubtype

public UnsignedInteger getParameterSubtype()

get parameterSubtype of type UnsignedInteger.

Returns:

type UnsignedInteger to be set

getData

public BytesToEnd_HEX getData()

get data of type BytesToEnd_HEX.

Returns:

BytesToEnd_HEX

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