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

Class Definition CImpinjExtendedTagInformation for LLRP parameter ImpinjExtendedTagInformation. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjExtendedTagInformation:
LLRP::CParameter LLRP::CElement

Public Member Functions

std::list< CEPCData * >::iterator beginEPCData (void)
 Returns the first element of the EPCData sub-parameter list.
 
std::list< CEPCData * >::iterator endEPCData (void)
 Returns the last element of the EPCData sub-parameter list.
 
void clearEPCData (void)
 Clears the LLRP EPCData sub-parameter list.
 
int countEPCData (void)
 Count of the LLRP EPCData sub-parameter list.
 
EResultCode addEPCData (CEPCData *pValue)
 Add a EPCData to the LLRP sub-parameter list.
 
CImpinjLocationReportDatagetImpinjLocationReportData (void)
 Get accessor functions for the LLRP ImpinjLocationReportData sub-parameter.
 
EResultCode setImpinjLocationReportData (CImpinjLocationReportData *pValue)
 Set accessor functions for the LLRP ImpinjLocationReportData sub-parameter.
 
CImpinjDirectionReportDatagetImpinjDirectionReportData (void)
 Get accessor functions for the LLRP ImpinjDirectionReportData sub-parameter.
 
EResultCode setImpinjDirectionReportData (CImpinjDirectionReportData *pValue)
 Set accessor functions for the LLRP ImpinjDirectionReportData 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
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

std::list< CEPCData * > m_listEPCData
 
CImpinjLocationReportDatam_pImpinjLocationReportData
 
CImpinjDirectionReportDatam_pImpinjDirectionReportData
 
std::list< CParameter * > m_listCustom
 

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. 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 CImpinjExtendedTagInformation for LLRP parameter ImpinjExtendedTagInformation.

<p>This custom parameter provides additional information about one or more tags that cannot be conveyed using the standard LLRP TagReportData parameter. The EPC is provided so an application may correlate this information with the associated TagReportData information as these parameters may arrive asynchronously with respect to the standard immediate reporting mechanism. Following the EPC is a set of parameters providing additional information about the tag, such as the direction in which it traveled through a portal.</p> 


<p>Note that no effort was made to optimize the EPC as was done in standard LLRP. All EPCs, regardless of length, are reported using the EPCData parameter.</p> 


<p>EPCData -- contains one or more EPCs for which this tag information applies </p> 

  <SMALL><i>Copyright 2007, 2008 Impinj Inc.</i></SMALL> 

Definition at line 12816 of file impinj_ltkcpp.h.

Member Function Documentation

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

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.

llrp_bool_t LLRP::CImpinjExtendedTagInformation::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: