EnvParam Struct Reference

A non-abstract EnvParam, derived from the base class. More...

Inheritance diagram for EnvParam:

Collaboration diagram for EnvParam:

Public Member Functions
	EnvParam (const Utopia::DataIO::Config &cfg)
	~EnvParam ()=default
double	get_env (const std::string &key) const override
	Getter.
void	set_env (const std::string &key, const double &value) override
	Setter.
	EnvParam (const Utopia::DataIO::Config &cfg)
	~EnvParam ()=default
double	get_env (const std::string &key) const override
	Getter.
void	set_env (const std::string &key, const double &value) override
	Setter.
Public Member Functions inherited from Utopia::Models::Environment::BaseEnvParam
virtual	~BaseEnvParam ()=default

Public Attributes
double	some_global_parameter
double	some_glob_parameter

Detailed Description

A non-abstract EnvParam, derived from the base class.

Note

This is used to allow standalone operation.

Constructor & Destructor Documentation

EnvParam() [1/2]

EnvParam::EnvParam ( const Utopia::DataIO::Config &  cfg )

inline

    : 
        some_global_parameter(Utopia::get_as<double>("some_global_parameter",
                                                     cfg, 0.))
    { }

~EnvParam() [1/2]

EnvParam::~EnvParam ( )

default

EnvParam() [2/2]

EnvParam::EnvParam ( const Utopia::DataIO::Config &  cfg )

inline

    : 
        some_glob_parameter(Utopia::get_as<double>("some_glob_parameter",
                                                     cfg, 0.))
    { }

~EnvParam() [2/2]

EnvParam::~EnvParam ( )

default

Member Function Documentation

get_env() [1/2]

double EnvParam::get_env ( const std::string &  key ) const

inlineoverridevirtual

Getter.

Implements Utopia::Models::Environment::BaseEnvParam.

                                                        {
        if (key == "some_global_parameter") {
            return some_global_parameter;
        }
        throw std::invalid_argument("No access method for key '" + key
                                    + "' in EnvParam!");
    }

get_env() [2/2]

double EnvParam::get_env ( const std::string &  key ) const

inlineoverridevirtual

Getter.

Implements Utopia::Models::Environment::BaseEnvParam.

                                                        {
        if (key == "some_glob_parameter") {
            return some_glob_parameter;
        }
        throw std::invalid_argument("No access method for key '" + key
                                    + "' in EnvParam!");
    }

set_env() [1/2]

void EnvParam::set_env ( const std::string &  key, const double &  value  )

inlineoverridevirtual

Setter.

Implements Utopia::Models::Environment::BaseEnvParam.

    {
        if (key == "some_global_parameter") {
            some_global_parameter = value;
        }
        else {
            throw std::invalid_argument("No setter method for key '" + key
                                        + "' in EnvParam!");
        }
    }

set_env() [2/2]

void EnvParam::set_env ( const std::string &  key, const double &  value  )

inlineoverridevirtual

Setter.

Implements Utopia::Models::Environment::BaseEnvParam.

    {
        if (key == "some_glob_parameter") {
            some_glob_parameter = value;
        }
        else {
            throw std::invalid_argument("No setter method for key '" + key
                                        + "' in EnvParam!");
        }
    }

Member Data Documentation

some_glob_parameter

double EnvParam::some_glob_parameter

some_global_parameter

double EnvParam::some_global_parameter

---

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

• src/utopia/models/Environment/Environment.cc
• src/utopia/models/Environment/test/test.cc