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

Class Definition CImpinjPlacementConfiguration for LLRP parameter ImpinjPlacementConfiguration. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjPlacementConfiguration:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_u16_t getHeightCm (void)
 Get accessor functions for the LLRP HeightCm field.
 
void setHeightCm (llrp_u16_t value)
 Set accessor functions for the LLRP HeightCm field.
 
llrp_s32_t getFacilityXLocationCm (void)
 Get accessor functions for the LLRP FacilityXLocationCm field.
 
void setFacilityXLocationCm (llrp_s32_t value)
 Set accessor functions for the LLRP FacilityXLocationCm field.
 
llrp_s32_t getFacilityYLocationCm (void)
 Get accessor functions for the LLRP FacilityYLocationCm field.
 
void setFacilityYLocationCm (llrp_s32_t value)
 Set accessor functions for the LLRP FacilityYLocationCm field.
 
llrp_s16_t getOrientationDegrees (void)
 Get accessor functions for the LLRP OrientationDegrees field.
 
void setOrientationDegrees (llrp_s16_t value)
 Set accessor functions for the LLRP OrientationDegrees field.
 
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_HeightCm
 
llrp_s32_t m_FacilityXLocationCm
 
llrp_s32_t m_FacilityYLocationCm
 
llrp_s16_t m_OrientationDegrees
 
std::list< CParameter * > m_listCustom
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdHeightCm
 
static const CFieldDescriptor s_fdFacilityXLocationCm
 
static const CFieldDescriptor s_fdFacilityYLocationCm
 
static const CFieldDescriptor s_fdOrientationDegrees
 
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 CImpinjPlacementConfiguration for LLRP parameter ImpinjPlacementConfiguration.

<p>HeightCm is used to initialize the xArray mounting height above the floor. When not specified, the default value is 457 cm</p> 


<p>FacilityXLocationCm is used to location this xArray in the facility. Its default is 0 and is not required with a single xArray</p> 


<p>FacilityYLocationCm is used to location this xArray in the facility. Its default is 0 and is not required with a single xArray</p> 


<p>OrientationDegrees specifies the orientation of the array in degrees (-180 - 180) with respect to the X orentation of the device.  Default is 0 and is not required with a single xArray deployment</p> 

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

Definition at line 10486 of file impinj_ltkcpp.h.

Member Function Documentation

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

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.

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