ModNameParamResolver Class Reference

API: ModNameParamResolver Class Reference
API
ModNameParamResolver Class Reference
Inheritance diagram for ModNameParamResolver:
[legend]

Public Member Functions

virtual bool resolve (const char *paramname, std::string &value) override

Description

A parameter resolver class for cXMLElement cXMLElement::getElementByPath().

Given a cModule pointer, this class resolves the following parameters: $MODULE_FULLPATH, $MODULE_FULLNAME, $MODULE_NAME, $MODULE_INDEX, $MODULE_ID; $PARENTMODULE_FULLPATH etc; $GRANDPARENTMODULE_FULLPATH etc.

Member Function Documentation

◆ resolve()

virtual bool resolve ( const char * paramname,
std::string & value )
overridevirtual

To be redefined in subclasses. If paramname is recognized, the method should store the value in the 'value' argument and return true; otherwise it should return false.

Implements cXMLElement::ParamResolver.