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

Class Definition CImpinjEnableOptimizedRead for LLRP parameter ImpinjEnableOptimizedRead. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjEnableOptimizedRead:
LLRP::CParameter LLRP::CElement

Public Member Functions

EImpinjOptimizedReadMode getOptimizedReadMode (void)
 Get accessor functions for the LLRP OptimizedReadMode field.
 
void setOptimizedReadMode (EImpinjOptimizedReadMode value)
 Set accessor functions for the LLRP OptimizedReadMode field.
 
std::list< CC1G2Read * >::iterator beginC1G2Read (void)
 Returns the first element of the C1G2Read sub-parameter list.
 
std::list< CC1G2Read * >::iterator endC1G2Read (void)
 Returns the last element of the C1G2Read sub-parameter list.
 
void clearC1G2Read (void)
 Clears the LLRP C1G2Read sub-parameter list.
 
int countC1G2Read (void)
 Count of the LLRP C1G2Read sub-parameter list.
 
EResultCode addC1G2Read (CC1G2Read *pValue)
 Add a C1G2Read 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
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

EImpinjOptimizedReadMode m_eOptimizedReadMode
 
std::list< CC1G2Read * > m_listC1G2Read
 
std::list< CParameter * > m_listCustom
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdOptimizedReadMode
 
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...
 
llrp_bool_t isAllowedIn (const CTypeDescriptor *pEnclosingElementType) const
 Validate whether the element is allowed as a base type in the enclosing element. 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 CImpinjEnableOptimizedRead for LLRP parameter ImpinjEnableOptimizedRead.

<p>This custom parameter configures the ImpinjOptimizedRead feature. ImpinjOptimizedRead allows for the reporting of additional tag memory content during an inventory without the use of AccessSpecs. The reader optimizes the execution of these reads for improved overall inventory performance.</p> 


<p>The memory bank and location of the reads are specified using the C1G2Read parameter, just as they are when using AccessSpecs. Similarly, the results of the reads are reported using the C1G2ReadOpSpecResult parameter within the TagReportData parameter. Reads issued using the ImpinjOptimizedRead feature are reported the same as reads using AccessSpecs and thus users should ensure the OpSpecIDs used for the operations are unique.</p> 


<p>Users may configure up to two optimized read operations. One departure from the AccessSpec model is optimized reads are always attempted, even if the first read fails. So for example, if the first read results in a failure due to a memory overrun, the second read will still be attempted. Thus, if there are two optimized reads configured it is guaranteed that there will be two C1G2ReadOpSpecResult parameters in each TagReportData parameter generated by the reader.</p> 


<p>Because this feature was designed for optimized inventory performance, any retries configured via the ImpinjOpSpecRetryCount parameter do not apply.</p> 

  <SMALL><i>Copyright 2010 Impinj Inc.</i></SMALL> 

Definition at line 7793 of file impinj_ltkcpp.h.

Member Function Documentation

void LLRP::CImpinjEnableOptimizedRead::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::CImpinjEnableOptimizedRead::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::CImpinjEnableOptimizedRead::encode ( CEncoderStream pEncoderStream) const
virtual

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.

llrp_bool_t LLRP::CImpinjEnableOptimizedRead::isAllowedIn ( const CTypeDescriptor pEnclosingTypeDescriptor) const
virtual

Validate whether the element is allowed as a base type in the enclosing element.

Parameters
[in]pEnclosingTypeDescriptorA pointer to the enclosing type
Returns
TRUE if the element is allowed to be encoded within the EnclosingElement
FALSE if the element is not allowed to be encoded within the EnclosingElement

Reimplemented from LLRP::CParameter.


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