ADTF  3.18.3
cConfigurationHelper< Child >

Common base class for all legacy filter classes that emulates the old configuration interface. More...

Protected Member Functions

void SetPropertyBool (const char *strName, bool bValue)
 Sets a Property value. More...
 
void SetPropertyInt (const char *strName, int nValue)
 Sets a Property value. More...
 
void SetPropertyFloat (const char *strName, double fValue)
 Sets a Property value. More...
 
void SetPropertyStr (const char *strName, const char *strValue)
 Sets a Property value. More...
 
bool GetPropertyBool (const char *strName, bool bDefault=false)
 Gets a Property value. More...
 
int GetPropertyInt (const char *strName, int nDefault=0)
 Gets a Property value. More...
 
double GetPropertyFloat (const char *strName, double fDefault=0.0)
 Gets a Property value. More...
 
adtf_util::cString GetPropertyStr (const tChar *strName, const tChar *strDefault="")
 Gets a Property value. More...
 

Detailed Description

template<typename Child>
class adtf::adtf2::ant::cConfigurationHelper< Child >

Common base class for all legacy filter classes that emulates the old configuration interface.

Definition at line 147 of file legacy_filter.h.

Member Function Documentation

◆ GetPropertyBool()

bool GetPropertyBool ( const char *  strName,
bool  bDefault = false 
)
inlineprotected

Gets a Property value.

Parameters
[in]strNameThe name of the Property.
[in]bDefaultThe default value of the Property that is returned if the Property does not exist.
Returns
The Property value.

Definition at line 197 of file legacy_filter.h.

◆ GetPropertyFloat()

double GetPropertyFloat ( const char *  strName,
double  fDefault = 0.0 
)
inlineprotected

Gets a Property value.

Parameters
[in]strNameThe name of the Property.
[in]fDefaultThe default value of the Property that is returned if the Property does not exist.
Returns
The Property value.

Definition at line 221 of file legacy_filter.h.

◆ GetPropertyInt()

int GetPropertyInt ( const char *  strName,
int  nDefault = 0 
)
inlineprotected

Gets a Property value.

Parameters
[in]strNameThe name of the Property.
[in]nDefaultThe default value of the Property that is returned if the Property does not exist.
Returns
The Property value.

Definition at line 209 of file legacy_filter.h.

◆ GetPropertyStr()

adtf_util::cString GetPropertyStr ( const tChar strName,
const tChar strDefault = "" 
)
inlineprotected

Gets a Property value.

Parameters
[in]strNameThe name of the Property.
[in]strDefaultThe default value of the Property that is returned if the Property does not exist.
Returns
The Property value.

Definition at line 234 of file legacy_filter.h.

◆ SetPropertyBool()

void SetPropertyBool ( const char *  strName,
bool  bValue 
)
inlineprotected

Sets a Property value.

Parameters
[in]strNameThe name of the Property.
[in]bValueThe value of the Property.

Definition at line 155 of file legacy_filter.h.

References adtf::base::ant::set_property().

◆ SetPropertyFloat()

void SetPropertyFloat ( const char *  strName,
double  fValue 
)
inlineprotected

Sets a Property value.

Parameters
[in]strNameThe name of the Property.
[in]fValueThe value of the Property.

Definition at line 175 of file legacy_filter.h.

References adtf::base::ant::set_property().

◆ SetPropertyInt()

void SetPropertyInt ( const char *  strName,
int  nValue 
)
inlineprotected

Sets a Property value.

Parameters
[in]strNameThe name of the Property.
[in]nValueThe value of the Property.

Definition at line 165 of file legacy_filter.h.

References adtf::base::ant::set_property().

◆ SetPropertyStr()

void SetPropertyStr ( const char *  strName,
const char *  strValue 
)
inlineprotected

Sets a Property value.

Parameters
[in]strNameThe name of the Property.
[in]strValueThe value of the Property.

Definition at line 185 of file legacy_filter.h.

References adtf::base::ant::set_property().