Utopia::Models::Environment::DummyEnvParam Struct Reference

Dummy type for environment parameter. More...

#include <Environment.hh>

Inheritance diagram for Utopia::Models::Environment::DummyEnvParam:

Collaboration diagram for Utopia::Models::Environment::DummyEnvParam:

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

Detailed Description

Dummy type for environment parameter.

This class is meant to be derived from and used as a basis for the desired kind of environment.

Constructor & Destructor Documentation

DummyEnvParam()

Utopia::Models::Environment::DummyEnvParam::DummyEnvParam ( const DataIO::Config &  )

inline

{ }

~DummyEnvParam()

Utopia::Models::Environment::DummyEnvParam::~DummyEnvParam ( )

default

Member Function Documentation

get_env()

double Utopia::Models::Environment::DummyEnvParam::get_env ( const std::string &  ) const

inlineoverridevirtual

Getter.

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

                                                    {
        throw std::invalid_argument("Accessing getter of the dummy type of "
                                    "EnvParam!");
    }

set_env()

void Utopia::Models::Environment::DummyEnvParam::set_env ( const std::string &  , const double &    )

inlineoverridevirtual

Setter.

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

                                                           {
        throw std::invalid_argument("Accessing setter of the dummy type of "
                                    "EnvParam!");
    }

---

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

• src/utopia/models/Environment/Environment.hh