Canoe
Comprehensive Atmosphere N' Ocean Engine
ParameterGroup Class Reference

#include <virtual_groups.hpp>

Inheritance diagram for ParameterGroup:
[legend]

Public Member Functions

virtual ~ParameterGroup ()
 
void SetRealsFrom (YAML::Node const &node)
 
void SetPar (std::string const &name, Real value)
 Set real parameter. More...
 
void SetPar (std::string const &name, int value)
 Set int parameter. More...
 
void SetPar (std::string const &name, std::string const &value)
 Set string parameter. More...
 
template<typename T >
GetPar (std::string const &name) const
 Get parameter. More...
 
bool HasPar (std::string const &name) const
 Check if a parameter exists. More...
 
template<>
int GetPar (std::string const &name) const
 
template<>
Real GetPar (std::string const &name) const
 

Private Attributes

std::unordered_map< std::string, Real > params_real_
 real parameters More...
 
std::unordered_map< std::string, int > params_int_
 int parameters More...
 
std::unordered_map< std::string, std::string > params_str_
 string parameters More...
 

Detailed Description

Definition at line 47 of file virtual_groups.hpp.

Constructor & Destructor Documentation

◆ ~ParameterGroup()

virtual ParameterGroup::~ParameterGroup ( )
inlinevirtual

Definition at line 49 of file virtual_groups.hpp.

Member Function Documentation

◆ SetRealsFrom()

void ParameterGroup::SetRealsFrom ( YAML::Node const &  node)
inline

Definition at line 51 of file virtual_groups.hpp.

◆ SetPar() [1/3]

void ParameterGroup::SetPar ( std::string const &  name,
Real  value 
)
inline

Set real parameter.

Definition at line 58 of file virtual_groups.hpp.

◆ SetPar() [2/3]

void ParameterGroup::SetPar ( std::string const &  name,
int  value 
)
inline

Set int parameter.

Definition at line 63 of file virtual_groups.hpp.

◆ SetPar() [3/3]

void ParameterGroup::SetPar ( std::string const &  name,
std::string const &  value 
)
inline

Set string parameter.

Definition at line 66 of file virtual_groups.hpp.

◆ GetPar() [1/3]

template<typename T >
T ParameterGroup::GetPar ( std::string const &  name) const

Get parameter.

◆ HasPar()

bool ParameterGroup::HasPar ( std::string const &  name) const
inline

Check if a parameter exists.

Definition at line 75 of file virtual_groups.hpp.

◆ GetPar() [2/3]

template<>
int ParameterGroup::GetPar ( std::string const &  name) const
inline

Definition at line 95 of file virtual_groups.hpp.

◆ GetPar() [3/3]

template<>
Real ParameterGroup::GetPar ( std::string const &  name) const
inline

Definition at line 100 of file virtual_groups.hpp.

Member Data Documentation

◆ params_real_

std::unordered_map<std::string, Real> ParameterGroup::params_real_
private

real parameters

Definition at line 84 of file virtual_groups.hpp.

◆ params_int_

std::unordered_map<std::string, int> ParameterGroup::params_int_
private

int parameters

Definition at line 87 of file virtual_groups.hpp.

◆ params_str_

std::unordered_map<std::string, std::string> ParameterGroup::params_str_
private

string parameters

Definition at line 90 of file virtual_groups.hpp.


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