PlasCom2  1.0
XPACC Multi-physics simluation application
Public Member Functions | Private Attributes | Friends | List of all members
ConfigurationObject Class Reference

Detailed Description

Definition at line 28 of file Configuration.H.

#include <Configuration.H>

Public Member Functions

std::vector< util::ConfigParameters > & GetParameters ()
 
util::ConfigParameters & Section (const std::string &section_name)
 Extract parameters for particular section. More...
 
void AddSection (util::ConfigParameters &params)
 
unsigned int SectionIndex (const std::string &section_name) const
 
std::string & NavigationSection (const std::string &section_name)
 
std::string NavigationSection (const std::string &section_name) const
 
std::vector< std::string > & NavigationSections ()
 
virtual std::string AdvanceToNextSection (std::istream &Inf)
 
virtual std::string ReadSection (std::istream &Inf)
 
virtual std::string ExtractSection (const std::string &section_name, std::istream &Inf)
 
- Public Member Functions inherited from ConfigParameters
 ConfigParameters ()
 
 ConfigParameters (const std::string &name)
 
const std::string & Name () const
 
void Name (const std::string &name)
 
- Public Member Functions inherited from Parameters
 Parameters ()
 
 Parameters (const Parameters &inParams)
 
std::string GetValue (const std::string &key) const
 
std::vector< std::string > GetValueVector (const std::string &key) const
 
util::ParamType * ParamPtr (const std::string &key)
 
bool GetFlagValue (const std::string &key) const
 
template<typename T >
T GetValue (const std::string &key) const
 
template<typename T >
std::vector< T > GetValueVector (const std::string &key) const
 
virtual void SetParameter (const std::string &key, const std::string &value)
 
template<typename T >
void SetParameter (const std::string &key, const T &value)
 
virtual int SetValue (const std::string &key, const std::string &value)
 
template<typename T >
int SetValue (const std::string &key, const T &value)
 
int ResetKey (const std::string &origKey, const std::string &newKey)
 
virtual std::istream & ReadFromStream (std::istream &Is)
 
virtual std::ostream & WriteToStream (std::ostream &Os) const
 
std::string Param (const std::string &Key) const
 
bool IsSet (const std::string &Key) const
 
virtual ~Parameters ()
 

Private Attributes

std::vector< util::ConfigParameters > _parameters
 
std::vector< std::string > _sections
 

Friends

std::ostream & operator<< (std::ostream &Ostr, const util::ConfigurationObject &cob)
 Stream output operator for util::ConfigurationObject. More...
 
std::istream & operator>> (std::istream &Istr, util::ConfigurationObject &cob)
 Stream input operator for util::ConfigurationObject. More...
 

Additional Inherited Members

- Public Types inherited from Parameters
typedef util::ParamType ParamType
 
Inheritance diagram for ConfigurationObject:
[legend]
Collaboration diagram for ConfigurationObject:
[legend]

Member Function Documentation

◆ AddSection()

void AddSection ( util::ConfigParameters &  params)
inline

Definition at line 38 of file Configuration.H.

◆ AdvanceToNextSection()

std::string AdvanceToNextSection ( std::istream &  Inf)
virtual

Definition at line 76 of file Configuration.C.

References ix::util::TokenizeString().

Referenced by ix::util::operator>>().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ ExtractSection()

std::string ExtractSection ( const std::string &  section_name,
std::istream &  Inf 
)
virtual

Definition at line 52 of file Configuration.C.

References ix::util::TokenizeString().

Referenced by ix::util::operator>>().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetParameters()

std::vector<util::ConfigParameters>& GetParameters ( )
inline

Definition at line 36 of file Configuration.H.

◆ NavigationSection() [1/2]

std::string & NavigationSection ( const std::string &  section_name)

Definition at line 44 of file Configuration.C.

◆ NavigationSection() [2/2]

std::string NavigationSection ( const std::string &  section_name) const

Definition at line 48 of file Configuration.C.

◆ NavigationSections()

std::vector<std::string>& NavigationSections ( )
inline

Definition at line 42 of file Configuration.H.

References Parameters::operator<<, and Parameters::operator>>.

◆ ReadSection()

std::string ReadSection ( std::istream &  Inf)
virtual

Definition at line 96 of file Configuration.C.

References ix::util::TokenizeString().

Referenced by ix::util::operator>>().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ Section()

util::ConfigParameters & Section ( const std::string &  section_name)

Extract parameters for particular section.

Definition at line 13 of file Configuration.C.

◆ SectionIndex()

unsigned int SectionIndex ( const std::string &  section_name) const

Definition at line 30 of file Configuration.C.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  Ostr,
const util::ConfigurationObject &  cob 
)
friend

Stream output operator for util::ConfigurationObject.

Definition at line 124 of file Configuration.C.

◆ operator>>

std::istream& operator>> ( std::istream &  Istr,
util::ConfigurationObject &  cob 
)
friend

Stream input operator for util::ConfigurationObject.

Definition at line 150 of file Configuration.C.

Member Data Documentation

◆ _parameters

std::vector<util::ConfigParameters> _parameters
private

Definition at line 33 of file Configuration.H.

Referenced by ix::util::operator<<(), and ix::util::operator>>().

◆ _sections

std::vector<std::string> _sections
private

Definition at line 34 of file Configuration.H.

Referenced by ix::util::operator<<(), and ix::util::operator>>().

The documentation for this class was generated from the following files: