ZeusBase-Library  2.0.4
zeus::IVariableResolver Class Referenceabstract

#include <IVariableResolver.hpp>

Inheritance diagram for zeus::IVariableResolver:
zeus::IZUnknown zeus::TVariableResolver zeus::TSettingsVariableResolver

Public Member Functions

virtual void MQUALIFIER addVariable (const IString &rName, const IString &rValue)=0
 
virtual void MQUALIFIER clearVariables ()=0
 
virtual void MQUALIFIER removeVariable (const IString &rName)=0
 
virtual Retval MQUALIFIER resolve (const IString &rData, IString &rOut, bool bRecursive)=0
 
- Public Member Functions inherited from zeus::IZUnknown
virtual Retval MQUALIFIER askForInterface (const InterfaceID &rInterfaceID, IZUnknown *&rpIface)=0
 
virtual void MQUALIFIER addRef () const =0
 
virtual void MQUALIFIER release () const =0
 

Detailed Description

Interface defines the access to a variable resolver

Member Function Documentation

§ addVariable()

virtual void MQUALIFIER zeus::IVariableResolver::addVariable ( const IString rName,
const IString rValue 
)
pure virtual

adds a new variable or overwrites an existing variable

Parameters
rName: Name of the variable
rValuevalue of the variable

Implemented in zeus::TVariableResolver.

§ clearVariables()

virtual void MQUALIFIER zeus::IVariableResolver::clearVariables ( )
pure virtual

clears the internal map of variables

Implemented in zeus::TVariableResolver.

§ removeVariable()

virtual void MQUALIFIER zeus::IVariableResolver::removeVariable ( const IString rName)
pure virtual

removes a variable

Parameters
rName: Name of the variable

Implemented in zeus::TVariableResolver.

§ resolve()

virtual Retval MQUALIFIER zeus::IVariableResolver::resolve ( const IString rData,
IString rOut,
bool  bRecursive 
)
pure virtual

Resolves all variables of a string

Parameters
rData: data string
rOut: result
bRecursive: if flag is set all variables containing other variables are also resolved
Return values
RET_NOERROR: Variable has been resolved or no variables has been found
RET_REQUEST_FAILED: Variable found but not resolved

Implemented in zeus::TVariableResolver.


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


Written by Benjamin Hadorn http://www.xatlantis.ch.
Last change made on Tue Sep 13 2016 22:31:41