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

Class Definition CImpinjDetailedVersion for LLRP parameter ImpinjDetailedVersion. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjDetailedVersion:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_utf8v_t getModelName (void)
 Get accessor functions for the LLRP ModelName field.
 
void setModelName (llrp_utf8v_t value)
 Set accessor functions for the LLRP ModelName field.
 
llrp_utf8v_t getSerialNumber (void)
 Get accessor functions for the LLRP SerialNumber field.
 
void setSerialNumber (llrp_utf8v_t value)
 Set accessor functions for the LLRP SerialNumber field.
 
llrp_utf8v_t getSoftwareVersion (void)
 Get accessor functions for the LLRP SoftwareVersion field.
 
void setSoftwareVersion (llrp_utf8v_t value)
 Set accessor functions for the LLRP SoftwareVersion field.
 
llrp_utf8v_t getFirmwareVersion (void)
 Get accessor functions for the LLRP FirmwareVersion field.
 
void setFirmwareVersion (llrp_utf8v_t value)
 Set accessor functions for the LLRP FirmwareVersion field.
 
llrp_utf8v_t getFPGAVersion (void)
 Get accessor functions for the LLRP FPGAVersion field.
 
void setFPGAVersion (llrp_utf8v_t value)
 Set accessor functions for the LLRP FPGAVersion field.
 
llrp_utf8v_t getPCBAVersion (void)
 Get accessor functions for the LLRP PCBAVersion field.
 
void setPCBAVersion (llrp_utf8v_t value)
 Set accessor functions for the LLRP PCBAVersion field.
 
CImpinjHubVersionsgetImpinjHubVersions (void)
 Get accessor functions for the LLRP ImpinjHubVersions sub-parameter.
 
EResultCode setImpinjHubVersions (CImpinjHubVersions *pValue)
 Set accessor functions for the LLRP ImpinjHubVersions sub-parameter.
 
CImpinjArrayVersiongetImpinjArrayVersion (void)
 Get accessor functions for the LLRP ImpinjArrayVersion sub-parameter.
 
EResultCode setImpinjArrayVersion (CImpinjArrayVersion *pValue)
 Set accessor functions for the LLRP ImpinjArrayVersion sub-parameter.
 
CImpinjBLEVersiongetImpinjBLEVersion (void)
 Get accessor functions for the LLRP ImpinjBLEVersion sub-parameter.
 
EResultCode setImpinjBLEVersion (CImpinjBLEVersion *pValue)
 Set accessor functions for the LLRP ImpinjBLEVersion 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_utf8v_t m_ModelName
 
llrp_utf8v_t m_SerialNumber
 
llrp_utf8v_t m_SoftwareVersion
 
llrp_utf8v_t m_FirmwareVersion
 
llrp_utf8v_t m_FPGAVersion
 
llrp_utf8v_t m_PCBAVersion
 
CImpinjHubVersionsm_pImpinjHubVersions
 
CImpinjArrayVersionm_pImpinjArrayVersion
 
CImpinjBLEVersionm_pImpinjBLEVersion
 
std::list< CParameter * > m_listCustom
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdModelName
 
static const CFieldDescriptor s_fdSerialNumber
 
static const CFieldDescriptor s_fdSoftwareVersion
 
static const CFieldDescriptor s_fdFirmwareVersion
 
static const CFieldDescriptor s_fdFPGAVersion
 
static const CFieldDescriptor s_fdPCBAVersion
 
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 CImpinjDetailedVersion for LLRP parameter ImpinjDetailedVersion.

<p>This custom parameter provides detailed information about the individual components running on the Reader. The primary platform version is available in the FirmwareVersion field in the GeneralDeviceCapabilities parameter of the Reader's capabilities. However, there are sub-components of the Reader that contain independent version information that is unavailable in this manner. This parameter provides this detailed information.</p> 

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

Definition at line 2619 of file impinj_ltkcpp.h.

Member Function Documentation

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

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.

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