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

Class Definition CImpinjRFPowerSweep for LLRP parameter ImpinjRFPowerSweep. More...

#include <impinj_ltkcpp.h>

Inheritance diagram for LLRP::CImpinjRFPowerSweep:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_u1_t getEnableRFPowerSweep (void)
 Get accessor functions for the LLRP EnableRFPowerSweep field.
 
void setEnableRFPowerSweep (llrp_u1_t value)
 Set accessor functions for the LLRP EnableRFPowerSweep field.
 
llrp_u16_t getMinimumPowerLevel (void)
 Get accessor functions for the LLRP MinimumPowerLevel field.
 
void setMinimumPowerLevel (llrp_u16_t value)
 Set accessor functions for the LLRP MinimumPowerLevel field.
 
llrp_u16_t getPowerLevelStepSize (void)
 Get accessor functions for the LLRP PowerLevelStepSize field.
 
void setPowerLevelStepSize (llrp_u16_t value)
 Set accessor functions for the LLRP PowerLevelStepSize 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_u1_t m_EnableRFPowerSweep
 
llrp_u16_t m_MinimumPowerLevel
 
llrp_u16_t m_PowerLevelStepSize
 
std::list< CParameter * > m_listCustom
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdEnableRFPowerSweep
 
static const CFieldDescriptor s_fdMinimumPowerLevel
 
static const CFieldDescriptor s_fdPowerLevelStepSize
 
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 CImpinjRFPowerSweep for LLRP parameter ImpinjRFPowerSweep.

<p>This custom parameter controls the RF Power Sweep feature.</p> 


<p> EnableRFPowerSweep: Set to enable RF Power Sweep, reset to disable. Reset by default.</p> 


<p> MinimumPowerLevel: Transmit Power above which to start the RF Power Sweep, expressed as an index into the TransmitPowerTable. Ignored if disabling feature. </p> 


<p> PowerLevelStepSize: Transmit Power step size by which to sweep power. Specified as power level index (0.25 dB increments).  Ignored if disabling feature. </p> 

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

Definition at line 15504 of file impinj_ltkcpp.h.

Member Function Documentation

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

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.

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