org.llrp.ltk.generated.parameters
Class GPIPortCurrentState

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

public class GPIPortCurrentState
extends TLVParameter

This Parameter carries the current configuration and state of a single GPI port. In a SET_READER_CONFIG message, this parameter is used to enable or disable the GPI port using the GPIConfig field; the GPIState field is ignored by the reader. In a GET_READER_CONFIG message, this parameter reports both the configuration and state of the GPI port.When a ROSpec or AISpec is configured on a GPI-capable reader with GPI start and/or stop triggers, those GPIs must be enabled by the client with a SET_READER_CONFIG message for the triggers to function.Readers that do not support GPIs SHALL set NumGPIs in the GPIOCapabilities to zero. If such a Reader receives a GET_READER_CONFIG with a GPIPortCurrentState 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.6.3 and LLRP Specification Section 16.2.6.9 .

Field Summary

protected Bit	config
protected UnsignedShort	gPIPortNum
protected BitList	reserved0
protected GPIPortState	state
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

GPIPortCurrentState()
empty constructor to create new parameter.

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

GPIPortCurrentState(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	getConfig() get config of type Bit.
UnsignedShort	getGPIPortNum() get gPIPortNum of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
GPIPortState	getState() get state of type GPIPortState.
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	setConfig(Bit config) set config of type Bit .
void	setGPIPortNum(UnsignedShort gPIPortNum) set gPIPortNum of type UnsignedShort .
void	setState(GPIPortState state) set state of type GPIPortState .
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

gPIPortNum

protected UnsignedShort gPIPortNum

config

protected Bit config

reserved0

protected BitList reserved0

state

protected GPIPortState state

Constructor Detail

GPIPortCurrentState

public GPIPortCurrentState()

empty constructor to create new parameter.

GPIPortCurrentState

public GPIPortCurrentState(LLRPBitList list)

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

Parameters:

list - to be decoded

GPIPortCurrentState

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

setGPIPortNum

public void setGPIPortNum(UnsignedShort gPIPortNum)

set gPIPortNum of type UnsignedShort .

Parameters:

gPIPortNum - to be set

setConfig

public void setConfig(Bit config)

set config of type Bit .

Parameters:

config - to be set

setState

public void setState(GPIPortState state)

set state of type GPIPortState .

Parameters:

state - to be set

getGPIPortNum

public UnsignedShort getGPIPortNum()

get gPIPortNum of type UnsignedShort.

Returns:

type UnsignedShort to be set

getConfig

public Bit getConfig()

get config of type Bit.

Returns:

type Bit to be set

getState

public GPIPortState getState()

get state of type GPIPortState.

Returns:

GPIPortState

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