PlasCom2  1.0
XPACC Multi-physics simluation application
Public Types | Public Member Functions | Friends | List of all members
Parameters Class Reference

Detailed Description

Definition at line 19 of file Parameters.H.

#include <Parameters.H>

Public Types

typedef util::ParamType ParamType
 

Public Member Functions

 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 ()
 

Friends

std::ostream & operator<< (std::ostream &oSt, const util::Parameters &pv)
 
std::istream & operator>> (std::istream &iSt, util::Parameters &pv)
 
Inheritance diagram for Parameters:
[legend]
Collaboration diagram for Parameters:
[legend]

Member Typedef Documentation

◆ ParamType

typedef util::ParamType ParamType

Definition at line 27 of file Parameters.H.

Constructor & Destructor Documentation

◆ Parameters() [1/2]

Parameters ( )
inline

Definition at line 28 of file Parameters.H.

◆ Parameters() [2/2]

Parameters ( const Parameters &  inParams)
inline

Definition at line 29 of file Parameters.H.

References Parameters::GetValue(), Parameters::GetValueVector(), and Parameters::ParamPtr().

Here is the call graph for this function:

◆ ~Parameters()

virtual ~Parameters ( )
inlinevirtual

Definition at line 136 of file Parameters.H.

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

Member Function Documentation

◆ GetFlagValue()

bool GetFlagValue ( const std::string &  key) const
inline

Definition at line 35 of file Parameters.H.

References Parameters::Param().

Referenced by plascom2::util::ConvertLegacyConfiguration().

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

◆ GetValue() [1/2]

std::string GetValue ( const std::string &  key) const

Definition at line 24 of file Parameters.C.

Referenced by ConfigStateValues(), base::Configure(), pcpp::util::ConfigureDataDictionary(), base< GridT, StateT >::ConfigureDomain(), plascom2::util::ConfigureGrid(), base::ConfigureGrid(), plascom2::util::ConfigureGridInfo(), plascom2::util::ConfigureGridSubRegions(), base::ConfigureState(), plascom2::util::ConfigureVirtualNode(), plascom2::util::ConvertLegacyConfiguration(), plascom2::GenerateGrid(), Parameters::Parameters(), application::RunApplication(), application::RunMaxwellSolver(), application::RunPlasCom2(), and application::WriteDomains().

Here is the caller graph for this function:

◆ GetValue() [2/2]

T GetValue ( const std::string &  key) const
inline

Definition at line 52 of file Parameters.H.

References Parameters::Param().

Here is the call graph for this function:

◆ GetValueVector() [1/2]

std::vector< std::string > GetValueVector ( const std::string &  key) const

Definition at line 36 of file Parameters.C.

Referenced by ConfigStateValues(), rk4advancer< DomainType >::Configure(), pcpp::util::ConfigureDataDictionary(), plascom2::util::ConfigureGrid(), plascom2::util::ConfigureGridInfo(), plascom2::util::ConfigureGridSubRegions(), base::ConfigureState(), plascom2::GenerateGrid(), Parameters::Parameters(), application::RunMaxwellSolver(), application::RunPlasCom2(), and TestPlasCom2Input().

Here is the caller graph for this function:

◆ GetValueVector() [2/2]

std::vector<T> GetValueVector ( const std::string &  key) const
inline

Definition at line 64 of file Parameters.H.

References Parameters::Param().

Here is the call graph for this function:

◆ IsSet()

bool IsSet ( const std::string &  Key) const

Definition at line 115 of file Parameters.C.

Referenced by ConfigStateValues(), base::Configure(), pcpp::util::ConfigureDataDictionary(), plascom2::util::ConfigureGrid(), base::ConfigureGrid(), plascom2::util::ConfigureGridInfo(), plascom2::util::ConfigureVirtualNode(), plascom2::util::ConvertLegacyConfiguration(), Parameters::ResetKey(), application::RunMaxwellSolver(), application::RunPlasCom2(), and application::WriteDomains().

Here is the caller graph for this function:

◆ Param()

std::string Param ( const std::string &  Key) const

Definition at line 91 of file Parameters.C.

Referenced by Parameters::GetFlagValue(), Parameters::GetValue(), Parameters::GetValueVector(), and Parameters::ResetKey().

Here is the caller graph for this function:

◆ ParamPtr()

util::ParamType * ParamPtr ( const std::string &  key)

Definition at line 12 of file Parameters.C.

Referenced by Parameters::Parameters(), Parameters::ResetKey(), Parameters::SetParameter(), and Parameters::SetValue().

Here is the caller graph for this function:

◆ ReadFromStream()

std::istream & ReadFromStream ( std::istream &  Is)
virtual

Definition at line 49 of file Parameters.C.

References KeyValuePairObj< K, V >::Key(), ix::util::TokenizeString(), KeyValuePairObj< K, V >::Value(), and x.

Referenced by ix::util::operator>>(), pcpp::util::ProcessConfigurationRestart(), and Parameters::ResetKey().

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

◆ ResetKey()

int ResetKey ( const std::string &  origKey,
const std::string &  newKey 
)
inline

Definition at line 123 of file Parameters.H.

References Parameters::IsSet(), KeyValuePairObj< K, V >::Key(), Parameters::Param(), Parameters::ParamPtr(), Parameters::ReadFromStream(), and Parameters::WriteToStream().

Referenced by plascom2::util::ConvertLegacyConfiguration().

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

◆ SetParameter() [1/2]

virtual void SetParameter ( const std::string &  key,
const std::string &  value 
)
inlinevirtual

Definition at line 77 of file Parameters.H.

References Parameters::ParamPtr(), and KeyValuePairObj< K, V >::Value().

Referenced by plascom2::util::ConvertLegacyConfiguration(), and navierstokes::CreateDictionaryConfiguration().

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

◆ SetParameter() [2/2]

void SetParameter ( const std::string &  key,
const T &  value 
)
inline

Definition at line 88 of file Parameters.H.

References Parameters::ParamPtr(), and KeyValuePairObj< K, V >::Value().

Here is the call graph for this function:

◆ SetValue() [1/2]

virtual int SetValue ( const std::string &  key,
const std::string &  value 
)
inlinevirtual

Definition at line 100 of file Parameters.H.

References Parameters::ParamPtr(), and KeyValuePairObj< K, V >::Value().

Here is the call graph for this function:

◆ SetValue() [2/2]

int SetValue ( const std::string &  key,
const T &  value 
)
inline

Definition at line 109 of file Parameters.H.

References KeyValuePairObj< K, V >::Key(), Parameters::ParamPtr(), and KeyValuePairObj< K, V >::Value().

Here is the call graph for this function:

◆ WriteToStream()

std::ostream & WriteToStream ( std::ostream &  Os) const
virtual

Definition at line 121 of file Parameters.C.

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

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  oSt,
const util::Parameters &  pv 
)
friend

Definition at line 132 of file Parameters.C.

Referenced by ConfigurationObject::NavigationSections(), and Parameters::~Parameters().

◆ operator>>

std::istream& operator>> ( std::istream &  iSt,
util::Parameters &  pv 
)
friend

Definition at line 138 of file Parameters.C.

Referenced by ConfigurationObject::NavigationSections(), and Parameters::~Parameters().

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