ProtoMol - an object-oriented component based framework for Molecular Dynamics simulations.
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

ProtoMol::Configuration Class Reference

#include <Configuration.h>

List of all members.

Public Types

typedef ValueMapType::const_iterator const_iterator

Public Member Functions

void registerKeyword (const std::string &keyword, Value value)
void registerAliases (const std::string &keyword, const std::vector< std::string > &aliases)
void unregisterKeyword (const std::string &keyword)
bool empty (const std::string &keyword=std::string("")) const
bool defined (const std::string &keyword) const
bool valid (const std::string &keyword) const
bool set (const std::string &keyword, Value)
bool set (const std::string &keyword, const std::string &val)
bool set (const std::string &keyword, const std::vector< std::vector< std::string > > &values)
bool set (const std::vector< std::vector< std::string > > &values)
bool setText (const std::string &keyword, const std::string &text)
Value get (const std::string &keyword) const
std::vector< Value > get (const std::vector< Parameter > &parameters) const
std::string getText (const std::string &keyword) const
std::vector< std::string > getAliases (const std::string &keyword) const
Value & operator[] (const std::string &keyword)
const Value & operator[] (const std::string &keyword) const
std::string print () const
bool validConfiguration () const
bool validConfiguration (std::string &errMsg) const
const_iterator begin () const
const_iterator end () const
const_iterator find (const std::string &keyword) const

Private Types

typedef std::map< std::string,
Value, ltstrNocase > 		ValueMapType
typedef std::map< std::string,
std::string, ltstrNocase > 		AliasMapType
typedef std::map< std::string,
std::string, ltstrNocase > 		TextMapType
typedef ValueMapType::iterator iterator

Private Member Functions

iterator begin ()
iterator end ()
iterator find (const std::string &keyword)

Private Attributes

ValueMapType myValues
AliasMapType myAliases
TextMapType myTexts

Detailed Description

Container (map) holding a system configuration, a keyword together with the value and an optional help text. The value use Value, which comes with additional information about the type and constraints.

Member Typedef Documentation

typedef std::map<std::string,std::string,ltstrNocase> ProtoMol::Configuration::AliasMapType [private]
 

typedef ValueMapType::const_iterator ProtoMol::Configuration::const_iterator
 

typedef ValueMapType::iterator ProtoMol::Configuration::iterator [private]
 

typedef std::map<std::string,std::string,ltstrNocase> ProtoMol::Configuration::TextMapType [private]
 

typedef std::map<std::string,Value,ltstrNocase> ProtoMol::Configuration::ValueMapType [private]
 

Member Function Documentation

iterator ProtoMol::Configuration::begin (   )  [inline, private]
 

const_iterator ProtoMol::Configuration::begin (   )  const [inline]
 

bool ProtoMol::Configuration::defined (  const std::string &  keyword  )  const
 

Test if the keyword has a defined type.

bool ProtoMol::Configuration::empty (  const std::string &  keyword = std::string("")  )  const
 

Test if the keyword exists.

iterator ProtoMol::Configuration::end (   )  [inline, private]
 

const_iterator ProtoMol::Configuration::end (   )  const [inline]
 

iterator ProtoMol::Configuration::find (  const std::string &  keyword  )  [private]
 

const_iterator ProtoMol::Configuration::find (  const std::string &  keyword  )  const
 

std::vector<Value> ProtoMol::Configuration::get (  const std::vector< Parameter > &  parameters  )  const
 

Value ProtoMol::Configuration::get (  const std::string &  keyword  )  const
 

std::vector<std::string> ProtoMol::Configuration::getAliases (  const std::string &  keyword  )  const
 

string ProtoMol::Configuration::getText (  const std::string &  keyword  )  const
 

const Value& ProtoMol::Configuration::operator[] (  const std::string &  keyword  )  const
 

Value& ProtoMol::Configuration::operator[] (  const std::string &  keyword  ) 
 

string ProtoMol::Configuration::print (   )  const
 

void ProtoMol::Configuration::registerAliases (  const std::string &  keyword,
const std::vector< std::string > &  aliases
) 
 

Register aliases for a given keyword.

void ProtoMol::Configuration::registerKeyword (  const std::string &  keyword,
Value  value
) 
 

Register new keyword with its value.

bool ProtoMol::Configuration::set (  const std::vector< std::vector< std::string > > &  values  ) 
 

bool ProtoMol::Configuration::set (  const std::string &  keyword,
const std::vector< std::vector< std::string > > &  values
) 
 

bool ProtoMol::Configuration::set (  const std::string &  keyword,
const std::string &  val
) 
 

bool ProtoMol::Configuration::set (  const std::string &  keyword,
Value 
) 
 

bool ProtoMol::Configuration::setText (  const std::string &  keyword,
const std::string &  text
) 
 

void ProtoMol::Configuration::unregisterKeyword (  const std::string &  keyword  ) 
 

Unregister a keyword.

bool ProtoMol::Configuration::valid (  const std::string &  keyword  )  const
 

Test if the keyword's value is valid.

bool ProtoMol::Configuration::validConfiguration (  std::string &  errMsg  )  const
 

bool ProtoMol::Configuration::validConfiguration (   )  const
 

Member Data Documentation

AliasMapType ProtoMol::Configuration::myAliases [private]
 

TextMapType ProtoMol::Configuration::myTexts [private]
 

ValueMapType ProtoMol::Configuration::myValues [private]
 

The documentation for this class was generated from the following files: Last update: . GNU GENERAL PUBLIC LICENSE, copyrighted by the University of Notre Dame and the University of Bergen, Norway.