LLRP::CGPITriggerValue Class Reference
[Core Parameter Classes]

Class Definition CGPITriggerValue for LLRP parameter GPITriggerValue. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CGPITriggerValue:

List of all members.

Internal Framework Functions
void	decodeFields (CDecoderStream *pDecoderStream)
	Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter.
void	assimilateSubParameters (CErrorDetails *pError)
	Assimilates the decoded sub-parameters into m_listAllSubParameters.
void	encode (CEncoderStream *pEncoderStream) const
	Encode fields and subparameters.
CElement *	s_construct (void)
void	s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)
const CFieldDescriptor *const	s_apFieldDescriptorTable []
const CTypeDescriptor	s_typeDescriptor
Public Member Functions
llrp_u16_t	getGPIPortNum (void)
	Get accessor functions for the LLRP GPIPortNum field.
void	setGPIPortNum (llrp_u16_t value)
	Set accessor functions for the LLRP GPIPortNum field.
llrp_u1_t	getGPIEvent (void)
	Get accessor functions for the LLRP GPIEvent field.
void	setGPIEvent (llrp_u1_t value)
	Set accessor functions for the LLRP GPIEvent field.
llrp_u32_t	getTimeout (void)
	Get accessor functions for the LLRP Timeout field.
void	setTimeout (llrp_u32_t value)
	Set accessor functions for the LLRP Timeout field.
Static Public Attributes
Internal Framework Functions
const CFieldDescriptor	s_fdGPIPortNum
Internal Framework Functions
const CFieldDescriptor	s_fdGPIEvent
Internal Framework Functions
const CFieldDescriptor	s_fdTimeout
Protected Attributes
llrp_u16_t	m_GPIPortNum
llrp_u1_t	m_GPIEvent
llrp_u32_t	m_Timeout

---

Detailed Description

Class Definition CGPITriggerValue for LLRP parameter GPITriggerValue.

• Document Reference LLRP Specification Section 10.2.1.1.1.2

• Document Reference LLRP Specification Section 16.2.4.1.1.1.2

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.

Copyright 2006, 2007, EPCglobal Inc. The proprietary text of EPCglobal Inc. included here is in not a Contribution to the LLRP toolkit, under Apache License, Version 2.0. The right to use the proprietary text is limited to reproduction and display thereof within the work.

---

Definition at line 10399 of file ltkcpp.h.

---

Member Function Documentation

void LLRP::CGPITriggerValue::assimilateSubParameters (  CErrorDetails *  pError  )  [virtual]

Assimilates the decoded sub-parameters into m_listAllSubParameters. After fields are decoded, the CDecoder itself takes care of gathering the subparameters into m_listAllSubParameters. Once the end of the enclosing TLV (or message) is reached this assimilateSubParameters() function is called to create parameter refrences from the primary member variables. Parameters: [out]  pError  Error details for encoded stream Implements LLRP::CElement.

void LLRP::CGPITriggerValue::decodeFields (  CDecoderStream *  pDecoderStream  )  [virtual]

Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter. Parameters: [in]  pDecoderStream  The stream from which to decode fields Returns: void Implements LLRP::CElement.

void LLRP::CGPITriggerValue::encode (  CEncoderStream *  pEncoderStream  )  const [virtual]

Encode fields and subparameters. Parameters: [in]  pEncoderStream  Stream to encode Returns: void Implements LLRP::CElement.

---

The documentation for this class was generated from the following file:

• ltkcpp.h

---