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

Class Definition CLLRPCapabilities for LLRP parameter LLRPCapabilities. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CLLRPCapabilities:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_u1_t getCanDoRFSurvey (void)
 Get accessor functions for the LLRP CanDoRFSurvey field.
 
void setCanDoRFSurvey (llrp_u1_t value)
 Set accessor functions for the LLRP CanDoRFSurvey field.
 
llrp_u1_t getCanReportBufferFillWarning (void)
 Get accessor functions for the LLRP CanReportBufferFillWarning field.
 
void setCanReportBufferFillWarning (llrp_u1_t value)
 Set accessor functions for the LLRP CanReportBufferFillWarning field.
 
llrp_u1_t getSupportsClientRequestOpSpec (void)
 Get accessor functions for the LLRP SupportsClientRequestOpSpec field.
 
void setSupportsClientRequestOpSpec (llrp_u1_t value)
 Set accessor functions for the LLRP SupportsClientRequestOpSpec field.
 
llrp_u1_t getCanDoTagInventoryStateAwareSingulation (void)
 Get accessor functions for the LLRP CanDoTagInventoryStateAwareSingulation field.
 
void setCanDoTagInventoryStateAwareSingulation (llrp_u1_t value)
 Set accessor functions for the LLRP CanDoTagInventoryStateAwareSingulation field.
 
llrp_u1_t getSupportsEventAndReportHolding (void)
 Get accessor functions for the LLRP SupportsEventAndReportHolding field.
 
void setSupportsEventAndReportHolding (llrp_u1_t value)
 Set accessor functions for the LLRP SupportsEventAndReportHolding field.
 
llrp_u8_t getMaxNumPriorityLevelsSupported (void)
 Get accessor functions for the LLRP MaxNumPriorityLevelsSupported field.
 
void setMaxNumPriorityLevelsSupported (llrp_u8_t value)
 Set accessor functions for the LLRP MaxNumPriorityLevelsSupported field.
 
llrp_u16_t getClientRequestOpSpecTimeout (void)
 Get accessor functions for the LLRP ClientRequestOpSpecTimeout field.
 
void setClientRequestOpSpecTimeout (llrp_u16_t value)
 Set accessor functions for the LLRP ClientRequestOpSpecTimeout field.
 
llrp_u32_t getMaxNumROSpecs (void)
 Get accessor functions for the LLRP MaxNumROSpecs field.
 
void setMaxNumROSpecs (llrp_u32_t value)
 Set accessor functions for the LLRP MaxNumROSpecs field.
 
llrp_u32_t getMaxNumSpecsPerROSpec (void)
 Get accessor functions for the LLRP MaxNumSpecsPerROSpec field.
 
void setMaxNumSpecsPerROSpec (llrp_u32_t value)
 Set accessor functions for the LLRP MaxNumSpecsPerROSpec field.
 
llrp_u32_t getMaxNumInventoryParameterSpecsPerAISpec (void)
 Get accessor functions for the LLRP MaxNumInventoryParameterSpecsPerAISpec field.
 
void setMaxNumInventoryParameterSpecsPerAISpec (llrp_u32_t value)
 Set accessor functions for the LLRP MaxNumInventoryParameterSpecsPerAISpec field.
 
llrp_u32_t getMaxNumAccessSpecs (void)
 Get accessor functions for the LLRP MaxNumAccessSpecs field.
 
void setMaxNumAccessSpecs (llrp_u32_t value)
 Set accessor functions for the LLRP MaxNumAccessSpecs field.
 
llrp_u32_t getMaxNumOpSpecsPerAccessSpec (void)
 Get accessor functions for the LLRP MaxNumOpSpecsPerAccessSpec field.
 
void setMaxNumOpSpecsPerAccessSpec (llrp_u32_t value)
 Set accessor functions for the LLRP MaxNumOpSpecsPerAccessSpec field.
 
- 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_u1_t m_CanDoRFSurvey
 
llrp_u1_t m_CanReportBufferFillWarning
 
llrp_u1_t m_SupportsClientRequestOpSpec
 
llrp_u1_t m_CanDoTagInventoryStateAwareSingulation
 
llrp_u1_t m_SupportsEventAndReportHolding
 
llrp_u8_t m_MaxNumPriorityLevelsSupported
 
llrp_u16_t m_ClientRequestOpSpecTimeout
 
llrp_u32_t m_MaxNumROSpecs
 
llrp_u32_t m_MaxNumSpecsPerROSpec
 
llrp_u32_t m_MaxNumInventoryParameterSpecsPerAISpec
 
llrp_u32_t m_MaxNumAccessSpecs
 
llrp_u32_t m_MaxNumOpSpecsPerAccessSpec
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdCanDoRFSurvey
 
static const CFieldDescriptor s_fdCanReportBufferFillWarning
 
static const CFieldDescriptor s_fdSupportsClientRequestOpSpec
 
static const CFieldDescriptor s_fdCanDoTagInventoryStateAwareSingulation
 
static const CFieldDescriptor s_fdSupportsEventAndReportHolding
 
static const CFieldDescriptor s_fdMaxNumPriorityLevelsSupported
 
static const CFieldDescriptor s_fdClientRequestOpSpecTimeout
 
static const CFieldDescriptor s_fdMaxNumROSpecs
 
static const CFieldDescriptor s_fdMaxNumSpecsPerROSpec
 
static const CFieldDescriptor s_fdMaxNumInventoryParameterSpecsPerAISpec
 
static const CFieldDescriptor s_fdMaxNumAccessSpecs
 
static const CFieldDescriptor s_fdMaxNumOpSpecsPerAccessSpec
 
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 CLLRPCapabilities for LLRP parameter LLRPCapabilities.

Document Reference LLRP Specification Section 9.2.2

Document Reference LLRP Specification Section 16.2.3.2

<p>This parameter describes the LLRP protocol capabilities of the Reader. These include optional LLRP commands and parameters, capacities of data structures used in LLRP operations, and air protocol specific capabilities used by LLRP.</p> 


<p>Readers 

MAY support RFSurvey, MAY support tag inventory state aware singulation, MAY support UTC clocks, MAY support buffer fill warning reports, MAY support EventAndReportHolding upon reconnect, and MAY support ClientRequestOpspec. Readers SHALL support at least one ROSpec, one AISpec per ROSpec, one InventoryParameterSpec per AISpec, one AccessSpec, and one OpSpec per AccessSpec.

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

Definition at line 8057 of file ltkcpp.h.

Member Function Documentation

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