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

Class Definition CFrequencyRSSILevelEntry for LLRP parameter FrequencyRSSILevelEntry. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CFrequencyRSSILevelEntry:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_u32_t getFrequency (void)
 Get accessor functions for the LLRP Frequency field.
 
void setFrequency (llrp_u32_t value)
 Set accessor functions for the LLRP Frequency field.
 
llrp_u32_t getBandwidth (void)
 Get accessor functions for the LLRP Bandwidth field.
 
void setBandwidth (llrp_u32_t value)
 Set accessor functions for the LLRP Bandwidth field.
 
llrp_s8_t getAverageRSSI (void)
 Get accessor functions for the LLRP AverageRSSI field.
 
void setAverageRSSI (llrp_s8_t value)
 Set accessor functions for the LLRP AverageRSSI field.
 
llrp_s8_t getPeakRSSI (void)
 Get accessor functions for the LLRP PeakRSSI field.
 
void setPeakRSSI (llrp_s8_t value)
 Set accessor functions for the LLRP PeakRSSI field.
 
CParametergetTimestamp (void)
 Get accessor functions for the LLRP Timestamp sub-parameter.
 
EResultCode setTimestamp (CParameter *pValue)
 Set accessor functions for the LLRP Timestamp sub-parameter.
 
- Public Member Functions inherited from LLRP::CParameter
virtual llrp_bool_t isAllowedIn (const CTypeDescriptor *pEnclosingTypeDescriptor) const
 Validate whether the element is allowed as a base type in the enclosing element. More...
 
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_u32_t m_Frequency
 
llrp_u32_t m_Bandwidth
 
llrp_s8_t m_AverageRSSI
 
llrp_s8_t m_PeakRSSI
 
CParameterm_pTimestamp
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdFrequency
 
static const CFieldDescriptor s_fdBandwidth
 
static const CFieldDescriptor s_fdAverageRSSI
 
static const CFieldDescriptor s_fdPeakRSSI
 
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...
 
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 CFrequencyRSSILevelEntry for LLRP parameter FrequencyRSSILevelEntry.

Document Reference LLRP Specification Section 13.2.4.1

Document Reference LLRP Specification Section 16.2.7.4.1

<p>Description</p> 


<ul>

<li>
<p>Frequency:  The frequency on which the measurement was taken, specified in kHz.</p> 
<li>
<p>Bandwidth:  The measurement bandwidth of the measurement in kHz.</p> 
<li>
<p>Average RSSI: The average power level observed at this frequency in dBm.</p> 
<li>
<p>Peak RSSI: The peak power level observed at this frequency in dBm.</p> 
     </ul> 

 <SMALL><i>Copyright 2006, 2007, EPCglobal Inc. The proprietary text of EPCglobal Inc. included here is in not a Contribution to the LLRP toolkit, under Apache License, Version 2.0. The right to use the proprietary text is limited to reproduction and display thereof within the work.</i></SMALL> 

Definition at line 16509 of file ltkcpp.h.

Member Function Documentation

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

Encode fields and subparameters.

Parameters
[in]pEncoderStreamStream to encode
Returns
void

Implements LLRP::CElement.


The documentation for this class was generated from the following file: