LLRP::CGPIPortCurrentState Class Reference
[Core Parameter Classes]

Class Definition CGPIPortCurrentState for LLRP parameter GPIPortCurrentState. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CGPIPortCurrentState:

LLRP::CParameter LLRP::CElement

List of all members.

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 getConfig (void)
 Get accessor functions for the LLRP Config field.
void setConfig (llrp_u1_t value)
 Set accessor functions for the LLRP Config field.
EGPIPortState getState (void)
 Get accessor functions for the LLRP State field.
void setState (EGPIPortState value)
 Set accessor functions for the LLRP State field.

Static Public Attributes

Internal Framework Functions


static const CFieldDescriptor s_fdGPIPortNum
Internal Framework Functions


static const CFieldDescriptor s_fdConfig
Internal Framework Functions


static const CFieldDescriptor s_fdState

Protected Attributes

llrp_u16_t m_GPIPortNum
llrp_u1_t m_Config
EGPIPortState m_eState

Internal Framework Functions



static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
static const CTypeDescriptor s_typeDescriptor
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.
static CElements_construct (void)
static void s_decodeFields (CDecoderStream *pDecoderStream, CElement *pElement)


Detailed Description

Class Definition CGPIPortCurrentState for LLRP parameter GPIPortCurrentState.

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.

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 13656 of file ltkcpp.h.


Member Function Documentation

void LLRP::CGPIPortCurrentState::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::CGPIPortCurrentState::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::CGPIPortCurrentState::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:

Generated on Wed Jun 6 11:55:53 2012 for LTKCPP-- LLRP Toolkit C Plus Plus Library by  doxygen 1.5.9