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

Base Class for All LLRP LTK Parameters. More...

#include <ltkcpp_base.h>

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

Public Member Functions

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...
 
virtual void decodeFields (CDecoderStream *pDecoderStream)=0
 Virtual function provided by each specific element type to decode fields (simple values). Leaves pDecoderStream at first subparameter. More...
 
virtual void assimilateSubParameters (CErrorDetails *pError)=0
 Assimilates the decoded sub-parameters into m_listAllSubParameters. More...
 
virtual void encode (CEncoderStream *pEncoderStream) const =0
 Encode fields and subparameters. More...
 

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

Base Class for All LLRP LTK Parameters.

Definition at line 1125 of file ltkcpp_base.h.

Member Function Documentation

◆ isAllowedExtension()

llrp_bool_t CParameter::isAllowedExtension ( const CTypeDescriptor pEnclosingTypeDescriptor)

Validate whether the element is allowed as an extension 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

Definition at line 127 of file ltkcpp_element.cpp.

References LLRP::CTypeDescriptor::m_bIsMessage, LLRP::CElement::m_pType, LLRP::CTypeDescriptor::m_pVendorDescriptor, and LLRP::CTypeDescriptor::m_TypeNum.

◆ isAllowedIn()

llrp_bool_t CParameter::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

Definition at line 120 of file ltkcpp_element.cpp.


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