#include <yateclass.h>
Inheritance diagram for NamedList:
Public Member Functions | |
NamedList (const char *name) | |
NamedList (const NamedList &original) | |
virtual void * | getObject (const String &name) const |
unsigned int | length () const |
unsigned int | count () const |
NamedList & | addParam (NamedString *param) |
NamedList & | addParam (const char *name, const char *value) |
NamedList & | setParam (NamedString *param) |
NamedList & | setParam (const char *name, const char *value) |
NamedList & | clearParam (const String &name, char childSep=0) |
NamedList & | copyParam (const NamedList &original, const String &name, char childSep=0) |
NamedList & | copyParams (const NamedList &original, ObjList *list, char childSep=0) |
NamedList & | copyParams (const NamedList &original, const String &list, char childSep=0) |
int | getIndex (const NamedString *param) const |
int | getIndex (const String &name) const |
NamedString * | getParam (const String &name) const |
NamedString * | getParam (unsigned int index) const |
const char * | getValue (const String &name, const char *defvalue=0) const |
int | getIntValue (const String &name, int defvalue=0) const |
int | getIntValue (const String &name, const TokenDict *tokens, int defvalue=0) const |
double | getDoubleValue (const String &name, double defvalue=0.0) const |
bool | getBoolValue (const String &name, bool defvalue=false) const |
int | replaceParams (String &str, bool sqlEsc=false, char extraEsc=0) const |
This class holds a named list of named strings
NamedList | ( | const char * | name | ) |
Creates a new named list.
name | Name of the list - must not be NULL or empty |
Copy constructor
original | Named list we are copying |
virtual void* getObject | ( | const String & | name | ) | const [virtual] |
unsigned int length | ( | ) | const [inline] |
unsigned int count | ( | ) | const [inline] |
Get the number of non-null parameters
NamedList& addParam | ( | NamedString * | param | ) |
Add a named string to the parameter list.
param | Parameter to add |
NamedList& addParam | ( | const char * | name, | |
const char * | value | |||
) |
Add a named string to the parameter list.
name | Name of the new string | |
value | Value of the new string |
NamedList& setParam | ( | NamedString * | param | ) |
Set a named string in the parameter list.
param | Parameter to set or add |
NamedList& setParam | ( | const char * | name, | |
const char * | value | |||
) |
Set a named string in the parameter list.
name | Name of the string | |
value | Value of the string |
Clears all instances of a named string in the parameter list.
name | Name of the string to remove | |
childSep | If set clears all child parameters in format name+childSep+anything |
Copy multiple parameters from another NamedList, clears them if not present there
int getIndex | ( | const NamedString * | param | ) | const |
Get the index of a named string in the parameter list.
param | Pointer to the parameter to locate |
int getIndex | ( | const String & | name | ) | const |
Get the index of first matching named string in the parameter list.
name | Name of parameter to locate |
NamedString* getParam | ( | const String & | name | ) | const |
Locate a named string in the parameter list.
name | Name of parameter to locate |
NamedString* getParam | ( | unsigned int | index | ) | const |
Locate a named string in the parameter list.
index | Index of the parameter to locate |
const char* getValue | ( | const String & | name, | |
const char * | defvalue = 0 | |||
) | const |
Retrive the value of a named parameter.
name | Name of parameter to locate | |
defvalue | Default value to return if not found |
int getIntValue | ( | const String & | name, | |
int | defvalue = 0 | |||
) | const |
Retrive the numeric value of a parameter.
name | Name of parameter to locate | |
defvalue | Default value to return if not found |
Retrive the numeric value of a parameter trying first a table lookup.
name | Name of parameter to locate | |
tokens | A pointer to an array of tokens to try to lookup | |
defvalue | Default value to return if not found |
double getDoubleValue | ( | const String & | name, | |
double | defvalue = 0.0 | |||
) | const |
Retrive the floating point value of a parameter.
name | Name of parameter to locate | |
defvalue | Default value to return if not found |
bool getBoolValue | ( | const String & | name, | |
bool | defvalue = false | |||
) | const |
Retrive the boolean value of a parameter.
name | Name of parameter to locate | |
defvalue | Default value to return if not found |
int replaceParams | ( | String & | str, | |
bool | sqlEsc = false , |
|||
char | extraEsc = 0 | |||
) | const |
Replaces all ${paramname} in a String with the corresponding parameters
str | String in which the replacements will be made | |
sqlEsc | True to apply SQL escaping to parameter values | |
extraEsc | Character to escape other than the SQL default ones |