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

Class Definition CInventoryParameterSpec for LLRP parameter InventoryParameterSpec. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CInventoryParameterSpec:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_u16_t getInventoryParameterSpecID (void)
 Get accessor functions for the LLRP InventoryParameterSpecID field.
 
void setInventoryParameterSpecID (llrp_u16_t value)
 Set accessor functions for the LLRP InventoryParameterSpecID field.
 
EAirProtocols getProtocolID (void)
 Get accessor functions for the LLRP ProtocolID field.
 
void setProtocolID (EAirProtocols value)
 Set accessor functions for the LLRP ProtocolID field.
 
std::list
< CAntennaConfiguration * >
::iterator 
beginAntennaConfiguration (void)
 Returns the first element of the AntennaConfiguration sub-parameter list.
 
std::list
< CAntennaConfiguration * >
::iterator 
endAntennaConfiguration (void)
 Returns the last element of the AntennaConfiguration sub-parameter list.
 
void clearAntennaConfiguration (void)
 Clears the LLRP AntennaConfiguration sub-parameter list.
 
int countAntennaConfiguration (void)
 Count of the LLRP AntennaConfiguration sub-parameter list.
 
EResultCode addAntennaConfiguration (CAntennaConfiguration *pValue)
 Add a AntennaConfiguration to the LLRP sub-parameter list.
 
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_u16_t m_InventoryParameterSpecID
 
EAirProtocols m_eProtocolID
 
std::list
< CAntennaConfiguration * > 
m_listAntennaConfiguration
 
std::list< CParameter * > m_listCustom
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdInventoryParameterSpecID
 
static const CFieldDescriptor s_fdProtocolID
 
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 CInventoryParameterSpec for LLRP parameter InventoryParameterSpec.

Document Reference LLRP Specification Section 10.2.2.2

Document Reference LLRP Specification Section 16.2.4.2.2

<p>This parameter defines the inventory operation to be performed at all antennas specified in the corresponding AISpec. This parameter is composed of an InventoryParameterSpecID, a ProtocolID, and zero or more optional antenna configuration parameters. Antenna configurations for antennas not indicated by the AntennaIDs within the AISpec are ignored by the reader.</p> 

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

Member Function Documentation

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