Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members

NamedList Class Reference

A named string container class. More...

#include <yateclass.h>

Inheritance diagram for NamedList:

String GenObject CallInfo Message List of all members.

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
NamedListaddParam (NamedString *param)
NamedListaddParam (const char *name, const char *value)
NamedListsetParam (NamedString *param)
NamedListsetParam (const char *name, const char *value)
NamedListclearParam (const String &name)
NamedStringgetParam (const String &name) const
NamedStringgetParam (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

Detailed Description

A named string container class.

This class holds a named list of named strings


Constructor & Destructor Documentation

NamedList const char *  name  ) 
 

Creates a new named list.

Parameters:
name Name of the list - must not be NULL or empty

NamedList const NamedList original  ) 
 

Copy constructor

Parameters:
original Named list we are copying


Member Function Documentation

NamedList& addParam const char *  name,
const char *  value
 

Add a named string to the parameter list.

Parameters:
name Name of the new string
value Value of the new string

NamedList& addParam NamedString param  ) 
 

Add a named string to the parameter list.

Parameters:
param Parameter to add

NamedList& clearParam const String name  ) 
 

Clars all instances of a named string in the parameter list.

Parameters:
name Name of the string to remove

unsigned int count  )  const [inline]
 

Get the number of non-null parameters

Returns:
Count of existing named strings

bool getBoolValue const String name,
bool  defvalue = false
const
 

Retrive the boolean value of a parameter.

Parameters:
name Name of parameter to locate
defvalue Default value to return if not found
Returns:
The boolean value contained in the named parameter or the default

double getDoubleValue const String name,
double  defvalue = 0.0
const
 

Retrive the floating point value of a parameter.

Parameters:
name Name of parameter to locate
defvalue Default value to return if not found
Returns:
The number contained in the named parameter or the default

int getIntValue const String name,
const TokenDict tokens,
int  defvalue = 0
const
 

Retrive the numeric value of a parameter trying first a table lookup.

Parameters:
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
Returns:
The number contained in the named parameter or the default

int getIntValue const String name,
int  defvalue = 0
const
 

Retrive the numeric value of a parameter.

Parameters:
name Name of parameter to locate
defvalue Default value to return if not found
Returns:
The number contained in the named parameter or the default

virtual void* getObject const String name  )  const [virtual]
 

Get a pointer to a derived class given that class name

Parameters:
name Name of the class we are asking for
Returns:
Pointer to the requested class or NULL if this object doesn't implement it

Reimplemented from String.

Reimplemented in Message.

NamedString* getParam unsigned int  index  )  const
 

Locate a named string in the parameter list.

Parameters:
index Index of the parameter to locate
Returns:
A pointer to the named string or NULL.

NamedString* getParam const String name  )  const
 

Locate a named string in the parameter list.

Parameters:
name Name of parameter to locate
Returns:
A pointer to the named string or NULL.

const char* getValue const String name,
const char *  defvalue = 0
const
 

Retrive the value of a named parameter.

Parameters:
name Name of parameter to locate
defvalue Default value to return if not found
Returns:
The string contained in the named parameter or the default

unsigned int length  )  const [inline]
 

Get the number of parameters

Returns:
Count of named strings

Reimplemented from String.

int replaceParams String str,
bool  sqlEsc = false,
char  extraEsc = 0
const
 

Replaces all ${paramname} in a String with the corresponding parameters

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
Returns:
Number of replacements made, -1 if an error occured

NamedList& setParam const char *  name,
const char *  value
 

Set a named string in the parameter list.

Parameters:
name Name of the string
value Value of the string

NamedList& setParam NamedString param  ) 
 

Set a named string in the parameter list.

Parameters:
param Parameter to set or add


The documentation for this class was generated from the following file:
Generated on Fri Jul 7 03:11:38 2006 for Yate by  doxygen 1.4.4