OSB_LIB::ModuleConfig Class Reference

Collaboration diagram for OSB_LIB::ModuleConfig:

Collaboration graph
[legend]
List of all members.

Detailed Description

Manager of configurations.

Definition at line 167 of file configuration.h.

Public Types

STL container type definitions

Public Member Functions

Wrappers to the list for browsing:
Note to developers: Add members as needed but make sure they are const!

Conversion of configuration value:
Convert a configuration value which stored in list_ based on the given keyword into the right value type, write the result to the argument pointer and return the result of the conversion.

Private Attributes


Member Typedef Documentation

typedef List::const_iterator OSB_LIB::ModuleConfig::ConstIterator

STL const_iterator.

Definition at line 179 of file configuration.h.

typedef List::iterator OSB_LIB::ModuleConfig::Iterator

STL iterator.

Definition at line 177 of file configuration.h.

typedef List::key_type OSB_LIB::ModuleConfig::KeyType

STL container key_type.

Definition at line 183 of file configuration.h.

typedef std::map<std::string, Configuration> OSB_LIB::ModuleConfig::List

STL containter used to store the configurations with keyword as the key.

Definition at line 175 of file configuration.h.

typedef List::size_type OSB_LIB::ModuleConfig::SizeType

STL container size_type.

Definition at line 181 of file configuration.h.


Member Enumeration Documentation

enum OSB_LIB::ModuleConfig::RetConvert

Return value of the conversion.

Where applicable the value must match Conversion::RetConvert.

Enumerator:
rcSuccess 
rcTypeMismatch 
rcErrConvert 
rcNotFound 

Definition at line 222 of file configuration.h.


Member Function Documentation

ConstIterator OSB_LIB::ModuleConfig::begin (  )  const [inline]

Iterator to the first entry.

Definition at line 196 of file configuration.h.

References list_.

RetConvert OSB_LIB::ModuleConfig::convert ( std::string *  pDest,
const std::string &  keyword 
) const

Convert to string type.

RetConvert OSB_LIB::ModuleConfig::convert ( long pDest,
const std::string &  keyword 
) const

Convert to long type.

RetConvert OSB_LIB::ModuleConfig::convert ( Date pDest,
const std::string &  keyword 
) const

Convert to date type.

ConstIterator OSB_LIB::ModuleConfig::end (  )  const [inline]

Iterator to end of the charge list.

Definition at line 198 of file configuration.h.

References list_.

const List& OSB_LIB::ModuleConfig::list (  )  const [inline]

Read access to the whole list of charges.

Definition at line 192 of file configuration.h.

References list_.

long OSB_LIB::ModuleConfig::read ( const OSB_DB::Session session,
const ModuleId  module 
)

Read the configurations for a module.

Parameters:
session Database session to use.
module Name of module to read for.
Returns:
The number of read configurations.
After the function returns list_ contains all database entries for module and all default configurations for which no module specific entry exists.

SizeType OSB_LIB::ModuleConfig::size (  )  const [inline]

Number of entries in the list.

Definition at line 194 of file configuration.h.

References list_.


Member Data Documentation

List OSB_LIB::ModuleConfig::list_ [private]

Definition at line 254 of file configuration.h.

Referenced by begin(), end(), list(), and size().


The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:11:04 2006 for OSB Library by  doxygen 1.4.7