org.llrp.ltk.generated.parameters
Class GPOWriteData

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

public class GPOWriteData
extends TLVParameter

This parameter carries the data pertinent to perform the write to a general purpose output port.Readers that do not support GPOs SHALL set NumGPOs in the GPIOCapabilities to zero. If such a Reader receives a SET_READER_CONFIG with GPOWriteData Parameter, the Reader SHALL return an error message and not process any of the parameters in that message. See also LLRP Specification Section 12.2.3 and LLRP Specification Section 16.2.6.3 .

Field Summary

protected Bit	gPOData
protected UnsignedShort	gPOPortNumber
protected BitList	reserved0
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

GPOWriteData()
empty constructor to create new parameter.

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

GPOWriteData(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.
Bit	getGPOData() get gPOData of type Bit.
UnsignedShort	getGPOPortNumber() get gPOPortNumber 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	setGPOData(Bit gPOData) set gPOData of type Bit .
void	setGPOPortNumber(UnsignedShort gPOPortNumber) set gPOPortNumber 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

gPOPortNumber

protected UnsignedShort gPOPortNumber

gPOData

protected Bit gPOData

reserved0

protected BitList reserved0

Constructor Detail

GPOWriteData

public GPOWriteData()

empty constructor to create new parameter.

GPOWriteData

public GPOWriteData(LLRPBitList list)

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

Parameters:

list - to be decoded

GPOWriteData

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

setGPOPortNumber

public void setGPOPortNumber(UnsignedShort gPOPortNumber)

set gPOPortNumber of type UnsignedShort .

Parameters:

gPOPortNumber - to be set

setGPOData

public void setGPOData(Bit gPOData)

set gPOData of type Bit .

Parameters:

gPOData - to be set

getGPOPortNumber

public UnsignedShort getGPOPortNumber()

get gPOPortNumber of type UnsignedShort.

Returns:

type UnsignedShort to be set

getGPOData

public Bit getGPOData()

get gPOData of type Bit.

Returns:

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