org.llrp.ltk.generated.parameters
Class GPITriggerValue

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

public class GPITriggerValue
extends TLVParameter

This trigger is tied to an event on the General Purpose Input (GPI) of the Reader. The event is represented as a boolean type, and it is up to the internal implementation of the Reader to map exact physical event to a boolean type. For example, a 0 to 1 and a 1 to 0 transition on an input pin of the Reader could be mapped to a boolean true and a boolean false event respectively.This trigger parameter has a timeout value field. The timeout is useful for specifying a fail-safe timeout when this trigger is used as a stop trigger. When the timeout is 0, it indicates that there is no timeout. When used as a start trigger, the timeout value SHALL be ignored.Readers that do not support GPIs SHALL return zero for numGPIs in the capabilities discovery. If the Client sets up the GPI trigger for such a Reader, the Reader SHALL send an error message for the ADD_ROSPEC message and not add the ROSpec. See also LLRP Specification Section 10.2.1.1.1.2 and LLRP Specification Section 16.2.4.1.1.1.2 .

Field Summary

protected Bit	gPIEvent
protected UnsignedShort	gPIPortNum
protected BitList	reserved0
protected UnsignedInteger	timeout
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

GPITriggerValue()
empty constructor to create new parameter.

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

GPITriggerValue(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	getGPIEvent() get gPIEvent of type Bit.
UnsignedShort	getGPIPortNum() get gPIPortNum of type UnsignedShort.
java.lang.String	getName() name of parameter (same as class name)
UnsignedInteger	getTimeout() get timeout of type UnsignedInteger.
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	setGPIEvent(Bit gPIEvent) set gPIEvent of type Bit .
void	setGPIPortNum(UnsignedShort gPIPortNum) set gPIPortNum of type UnsignedShort .
void	setTimeout(UnsignedInteger timeout) set timeout 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

Field Detail

TYPENUM

public static final SignedShort TYPENUM

gPIPortNum

protected UnsignedShort gPIPortNum

gPIEvent

protected Bit gPIEvent

reserved0

protected BitList reserved0

timeout

protected UnsignedInteger timeout

Constructor Detail

GPITriggerValue

public GPITriggerValue()

empty constructor to create new parameter.

GPITriggerValue

public GPITriggerValue(LLRPBitList list)

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

Parameters:

list - to be decoded

GPITriggerValue

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

setGPIEvent

public void setGPIEvent(Bit gPIEvent)

set gPIEvent of type Bit .

Parameters:

gPIEvent - to be set

setTimeout

public void setTimeout(UnsignedInteger timeout)

set timeout of type UnsignedInteger .

Parameters:

timeout - to be set

getGPIPortNum

public UnsignedShort getGPIPortNum()

get gPIPortNum of type UnsignedShort.

Returns:

type UnsignedShort to be set

getGPIEvent

public Bit getGPIEvent()

get gPIEvent of type Bit.

Returns:

type Bit to be set

getTimeout

public UnsignedInteger getTimeout()

get timeout of type UnsignedInteger.

Returns:

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