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

Class Definition CImpinjLocationConfig for LLRP parameter ImpinjLocationConfig. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjLocationConfig:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_u16_t getComputeWindowSeconds (void)
 Get accessor functions for the LLRP ComputeWindowSeconds field.
 
void setComputeWindowSeconds (llrp_u16_t value)
 Set accessor functions for the LLRP ComputeWindowSeconds field.
 
llrp_u16_t getTagAgeIntervalSeconds (void)
 Get accessor functions for the LLRP TagAgeIntervalSeconds field.
 
void setTagAgeIntervalSeconds (llrp_u16_t value)
 Set accessor functions for the LLRP TagAgeIntervalSeconds field.
 
llrp_u16_t getUpdateIntervalSeconds (void)
 Get accessor functions for the LLRP UpdateIntervalSeconds field.
 
void setUpdateIntervalSeconds (llrp_u16_t value)
 Set accessor functions for the LLRP UpdateIntervalSeconds field.
 
CImpinjDisabledAntennasgetImpinjDisabledAntennas (void)
 Get accessor functions for the LLRP ImpinjDisabledAntennas sub-parameter.
 
EResultCode setImpinjDisabledAntennas (CImpinjDisabledAntennas *pValue)
 Set accessor functions for the LLRP ImpinjDisabledAntennas 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

llrp_u16_t m_ComputeWindowSeconds
 
llrp_u16_t m_TagAgeIntervalSeconds
 
llrp_u16_t m_UpdateIntervalSeconds
 
CImpinjDisabledAntennasm_pImpinjDisabledAntennas
 
std::list< CParameter * > m_listCustom
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdComputeWindowSeconds
 
static const CFieldDescriptor s_fdTagAgeIntervalSeconds
 
static const CFieldDescriptor s_fdUpdateIntervalSeconds
 
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 CImpinjLocationConfig for LLRP parameter ImpinjLocationConfig.

<p>This parameter specifies the settings of the location algorithm</p> 


<p>The ComputeWindowSeconds field specifies the size of the smoothing window for averaging the location estimates. Default is 10 seconds</p> 


<p>The TagAgeIntervalSeconds field specifies how long a tag needs to go unseen before its removed from the location tracking. Default is 20 seconds</p> 


<p>The UpdateIntervalSeconds field specifies how often tag location estimate is computed</p> 


<p>The ImpinjDisabledAntennas parameter may optionally be included to specify antennas to exclude from computation of the location estimate</p> 

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

Definition at line 10241 of file impinj_ltkcpp.h.

Member Function Documentation

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

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.

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