LTKCPP-- LLRP Toolkit C Plus Plus Library
Public Member Functions | Protected Attributes | List of all members
LLRP::CAccessSpec Class Reference

Class Definition CAccessSpec for LLRP parameter AccessSpec. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CAccessSpec:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_u32_t getAccessSpecID (void)
 Get accessor functions for the LLRP AccessSpecID field.
 
void setAccessSpecID (llrp_u32_t value)
 Set accessor functions for the LLRP AccessSpecID field.
 
llrp_u16_t getAntennaID (void)
 Get accessor functions for the LLRP AntennaID field.
 
void setAntennaID (llrp_u16_t value)
 Set accessor functions for the LLRP AntennaID field.
 
EAirProtocols getProtocolID (void)
 Get accessor functions for the LLRP ProtocolID field.
 
void setProtocolID (EAirProtocols value)
 Set accessor functions for the LLRP ProtocolID field.
 
EAccessSpecState getCurrentState (void)
 Get accessor functions for the LLRP CurrentState field.
 
void setCurrentState (EAccessSpecState value)
 Set accessor functions for the LLRP CurrentState field.
 
llrp_u32_t getROSpecID (void)
 Get accessor functions for the LLRP ROSpecID field.
 
void setROSpecID (llrp_u32_t value)
 Set accessor functions for the LLRP ROSpecID field.
 
CAccessSpecStopTriggergetAccessSpecStopTrigger (void)
 Get accessor functions for the LLRP AccessSpecStopTrigger sub-parameter.
 
EResultCode setAccessSpecStopTrigger (CAccessSpecStopTrigger *pValue)
 Set accessor functions for the LLRP AccessSpecStopTrigger sub-parameter.
 
CAccessCommandgetAccessCommand (void)
 Get accessor functions for the LLRP AccessCommand sub-parameter.
 
EResultCode setAccessCommand (CAccessCommand *pValue)
 Set accessor functions for the LLRP AccessCommand sub-parameter.
 
CAccessReportSpecgetAccessReportSpec (void)
 Get accessor functions for the LLRP AccessReportSpec sub-parameter.
 
EResultCode setAccessReportSpec (CAccessReportSpec *pValue)
 Set accessor functions for the LLRP AccessReportSpec sub-parameter.
 
std::list< CParameter * >::iterator beginCustom (void)
 Returns the first element of the Custom sub-parameter list.
 
std::list< CParameter * >::iterator endCustom (void)
 Returns the last element of the Custom sub-parameter list.
 
void clearCustom (void)
 Clears the LLRP Custom sub-parameter list.
 
int countCustom (void)
 Count of the LLRP Custom sub-parameter list.
 
EResultCode addCustom (CParameter *pValue)
 Add a Custom to the LLRP sub-parameter list.
 
- Public Member Functions inherited from LLRP::CParameter
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...
 
- Public Member Functions inherited from LLRP::CElement
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_u32_t m_AccessSpecID
 
llrp_u16_t m_AntennaID
 
EAirProtocols m_eProtocolID
 
EAccessSpecState m_eCurrentState
 
llrp_u32_t m_ROSpecID
 
CAccessSpecStopTriggerm_pAccessSpecStopTrigger
 
CAccessCommandm_pAccessCommand
 
CAccessReportSpecm_pAccessReportSpec
 
std::list< CParameter * > m_listCustom
 

Internal Framework Functions

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

Additional Inherited Members

- Public Attributes inherited from LLRP::CElement
const CTypeDescriptorm_pType
 The type descriptor desribing this element.
 
CElementm_pParent
 Element that encloses this one, NULL if this is top-level element.
 
tListOfParameters m_listAllSubParameters
 List of all sub elements.
 

Detailed Description

Class Definition CAccessSpec for LLRP parameter AccessSpec.

Document Reference LLRP Specification Section 11.2.1

Document Reference LLRP Specification Section 16.2.5.1

<p>This parameter carries information of the Reader access operation.</p> 

Copyright 2006, 2007, EPCglobal Inc.


Definition at line 11377 of file ltkcpp.h.

Member Function Documentation

void LLRP::CAccessSpec::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]pErrorError details for encoded stream

Implements LLRP::CElement.

void LLRP::CAccessSpec::decodeFields ( CDecoderStream pDecoderStream)
virtual

Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter.

Parameters
[in]pDecoderStreamThe stream from which to decode fields
Returns
void

Implements LLRP::CElement.

void LLRP::CAccessSpec::encode ( CEncoderStream pEncoderStream) const
virtual

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.


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