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

Class Definition CFrequencyInformation for LLRP parameter FrequencyInformation. More...

#include <ltkcpp.h>

Inheritance diagram for LLRP::CFrequencyInformation:
LLRP::CParameter LLRP::CElement

Public Member Functions

llrp_u1_t getHopping (void)
 Get accessor functions for the LLRP Hopping field.
 
void setHopping (llrp_u1_t value)
 Set accessor functions for the LLRP Hopping field.
 
std::list< CFrequencyHopTable * >
::iterator 
beginFrequencyHopTable (void)
 Returns the first element of the FrequencyHopTable sub-parameter list.
 
std::list< CFrequencyHopTable * >
::iterator 
endFrequencyHopTable (void)
 Returns the last element of the FrequencyHopTable sub-parameter list.
 
void clearFrequencyHopTable (void)
 Clears the LLRP FrequencyHopTable sub-parameter list.
 
int countFrequencyHopTable (void)
 Count of the LLRP FrequencyHopTable sub-parameter list.
 
EResultCode addFrequencyHopTable (CFrequencyHopTable *pValue)
 Add a FrequencyHopTable to the LLRP sub-parameter list.
 
CFixedFrequencyTablegetFixedFrequencyTable (void)
 Get accessor functions for the LLRP FixedFrequencyTable sub-parameter.
 
EResultCode setFixedFrequencyTable (CFixedFrequencyTable *pValue)
 Set accessor functions for the LLRP FixedFrequencyTable 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_u1_t m_Hopping
 
std::list< CFrequencyHopTable * > m_listFrequencyHopTable
 
CFixedFrequencyTablem_pFixedFrequencyTable
 

Internal Framework Functions

static const CFieldDescriptor
*const 
s_apFieldDescriptorTable []
 
static const CTypeDescriptor s_typeDescriptor
 
static const CFieldDescriptor s_fdHopping
 
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 CFrequencyInformation for LLRP parameter FrequencyInformation.

Document Reference LLRP Specification Section 9.2.4.1.2

Document Reference LLRP Specification Section 16.2.3.4.1.2

<p>Describes the fixed frequency or hopping frequencies supported in this UHFBand.</p> 

Definition at line 8921 of file ltkcpp.h.

Member Function Documentation

void LLRP::CFrequencyInformation::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::CFrequencyInformation::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::CFrequencyInformation::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: