[]Jimmy's World.org
Because you all make me very, very tired.
[]
Jimmy's World Games
Not a Member? - Login or Create an Account
[] Tuesday the 6th of January 2009 @ 12:26pm
News Journal Creative Writing Projects Your JW About

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

n2l::cConfigurationTemplate Class Reference

#include <cConfigurationTemplate.h>

List of all members.

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Classes

  • class cConfValidatorNoValidator
    A shell validator to return as the error for values that have no validator, but where optional arguments are not allowed. More...

Detailed Description

Definition at line 37 of file cConfigurationTemplate.h.


Member Typedef Documentation

typedef tContainer::const_iterator n2l::cConfigurationTemplate::tConstIterator
 

Definition at line 62 of file cConfigurationTemplate.h.

typedef std::map<tString,cAutoPtr<cConfValidatorInterface> > n2l::cConfigurationTemplate::tContainer [protected]
 

Definition at line 46 of file cConfigurationTemplate.h.

typedef std::map<tString,cDynVar> n2l::cConfigurationTemplate::tDefaultsContainer [protected]
 

Definition at line 48 of file cConfigurationTemplate.h.

typedef tContainer::iterator n2l::cConfigurationTemplate::tIterator
 

Definition at line 63 of file cConfigurationTemplate.h.

typedef std::map<tString,tRequirement> n2l::cConfigurationTemplate::tRequiredContainer [protected]
 

Definition at line 47 of file cConfigurationTemplate.h.

typedef tContainer::size_type n2l::cConfigurationTemplate::tSize
 

Definition at line 65 of file cConfigurationTemplate.h.


Member Enumeration Documentation

enum n2l::cConfigurationTemplate::tRequirement [protected]
 

Enumerator:
Requirement_Optional 
Requirement_Required 
Requirement_Override 

Definition at line 40 of file cConfigurationTemplate.h.


Constructor & Destructor Documentation

n2l::cConfigurationTemplate::cConfigurationTemplate  ) 
 

Definition at line 34 of file cConfigurationTemplate.cpp.

n2l::cConfigurationTemplate::~cConfigurationTemplate  ) 
 

Definition at line 41 of file cConfigurationTemplate.cpp.


Member Function Documentation

void n2l::cConfigurationTemplate::addPair const tString iKey,
const cAutoPtr< cConfValidatorInterface iValidator,
const tBool  iValueRequired = true
 

Definition at line 129 of file cConfigurationTemplate.cpp.

References Requirement_Optional, and Requirement_Required.

void n2l::cConfigurationTemplate::addPairWithDefault const tString iKey,
const cAutoPtr< cConfValidatorInterface iValidator,
const cDynVar iDefault
 

Definition at line 141 of file cConfigurationTemplate.cpp.

References Requirement_Override.

const tBool n2l::cConfigurationTemplate::allowUnvalidatedKeys  )  const
 

Definition at line 205 of file cConfigurationTemplate.cpp.

Referenced by pairIsOk(), and validate().

void n2l::cConfigurationTemplate::applyDefaults cConfiguration ioConfig  )  const
 

Definition at line 119 of file cConfigurationTemplate.cpp.

References n2l::cConfiguration::isSet().

Referenced by validate().

const cConfigurationTemplate::tIterator n2l::cConfigurationTemplate::begin  )  [protected]
 

Definition at line 54 of file cConfigurationTemplate.cpp.

const cConfigurationTemplate::tConstIterator n2l::cConfigurationTemplate::begin  )  const [protected]
 

Definition at line 47 of file cConfigurationTemplate.cpp.

Referenced by dump(), and validate().

void n2l::cConfigurationTemplate::clear  ) 
 

Definition at line 191 of file cConfigurationTemplate.cpp.

const tString n2l::cConfigurationTemplate::dump  )  const
 

Definition at line 212 of file cConfigurationTemplate.cpp.

References begin(), and end().

const tBool n2l::cConfigurationTemplate::empty  )  const
 

Definition at line 177 of file cConfigurationTemplate.cpp.

const cConfigurationTemplate::tIterator n2l::cConfigurationTemplate::end  )  [protected]
 

Definition at line 68 of file cConfigurationTemplate.cpp.

const cConfigurationTemplate::tConstIterator n2l::cConfigurationTemplate::end  )  const [protected]
 

Definition at line 61 of file cConfigurationTemplate.cpp.

Referenced by dump(), isset(), and validate().

const tBool n2l::cConfigurationTemplate::isset const tString iName  )  const
 

Definition at line 169 of file cConfigurationTemplate.cpp.

References end().

Referenced by validate().

const cConfValidatorInterface *const n2l::cConfigurationTemplate::pairIsOk const tString iName,
const cDynVar iValue
const
 

Definition at line 152 of file cConfigurationTemplate.cpp.

References allowUnvalidatedKeys(), and n2l::cConfigurationTemplate::cConfValidatorNoValidator::valueOk().

void n2l::cConfigurationTemplate::setUnvalidatedKeysAllowed const tBool  iAllowed  ) 
 

Definition at line 198 of file cConfigurationTemplate.cpp.

const cConfigurationTemplate::tSize n2l::cConfigurationTemplate::size  )  const
 

Definition at line 184 of file cConfigurationTemplate.cpp.

void n2l::cConfigurationTemplate::validate cConfiguration ioConfig  )  const
 

Definition at line 74 of file cConfigurationTemplate.cpp.

References n2l::cConfParsingErrors::add(), allowUnvalidatedKeys(), applyDefaults(), n2l::cConfiguration::begin(), begin(), n2l::cConfigurationTemplate::cConfValidatorNoValidator::describe(), n2l::cConfValidatorInterface::describe(), n2l::cConfParsingErrors::empty(), n2l::cConfiguration::end(), end(), n2l::cConfParsingError::ErrorType_ValidationFailed, n2l::cConfiguration::find(), isset(), Requirement_Required, and n2l::cConfValidatorInterface::valueOk().


The documentation for this class was generated from the following files:
©2009 Aaron Cameron
Benchmarks