LTKCPP-- LLRP Toolkit C Plus Plus Library
|
Class Definition CGPITriggerValue for LLRP parameter GPITriggerValue. More...
#include <ltkcpp.h>
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. | |
![]() | |
virtual llrp_bool_t | isAllowedIn (const CTypeDescriptor *pEnclosingTypeDescriptor) const |
Validate whether the element is allowed as a base type in the enclosing element. More... | |
llrp_bool_t | isAllowedExtension (const CTypeDescriptor *pEnclosingTypeDescriptor) |
Validate whether the element is allowed as an extension in the enclosing element. More... | |
![]() | |
void | addSubParameterToAllList (CParameter *pParameter) |
Add a subparameter to m_listAllSubParameters. Called by the accessor functions setXXX and addXXX. More... | |
void | removeSubParameterFromAllList (CParameter *pParameter) |
Delete a subparameter from m_listAllSubParameters. Called by the accessor functions setXXX (to remove prior reference) clearXXX(). More... | |
void | clearSubParameterList (tListOfParameters *pParameterList) |
Clear a list of subparameters. For each entry apply removeSubParameter(). More... | |
int | walk (int(*pFunc)(const CElement *pElement, void *pArg), void *pArg, int iDepth, int nMaxDepth) const |
Recursive tree walk. The callback is invoked for each element. | |
EResultCode | toXMLString (char *pBuffer, int nBuffer) |
A wrapper around LLRP::toXMLString() More... | |
Protected Attributes | |
llrp_u16_t | m_GPIPortNum |
llrp_u1_t | m_GPIEvent |
llrp_u32_t | m_Timeout |
Internal Framework Functions | |
static const CFieldDescriptor *const | s_apFieldDescriptorTable [] |
static const CTypeDescriptor | s_typeDescriptor |
static const CFieldDescriptor | s_fdGPIPortNum |
static const CFieldDescriptor | s_fdGPIEvent |
static const CFieldDescriptor | s_fdTimeout |
void | decodeFields (CDecoderStream *pDecoderStream) |
Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter. More... | |
void | assimilateSubParameters (CErrorDetails *pError) |
Assimilates the decoded sub-parameters into m_listAllSubParameters. More... | |
void | encode (CEncoderStream *pEncoderStream) const |
Encode fields and subparameters. More... | |
static CElement * | s_construct (void) |
static void | s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement) |
Additional Inherited Members | |
![]() | |
const CTypeDescriptor * | m_pType |
The type descriptor desribing this element. | |
CElement * | m_pParent |
Element that encloses this one, NULL if this is top-level element. | |
tListOfParameters | m_listAllSubParameters |
List of all sub elements. | |
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
<p>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.</p> <p>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.
<p>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.
<SMALL><i>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.</i></SMALL>
|
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.
[out] | pError | Error details for encoded stream |
Implements LLRP::CElement.
|
virtual |
Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter.
[in] | pDecoderStream | The stream from which to decode fields |
Implements LLRP::CElement.
|
virtual |
Encode fields and subparameters.
[in] | pEncoderStream | Stream to encode |
Implements LLRP::CElement.