EnvCellState Struct Reference

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

Inheritance diagram for EnvCellState:

Collaboration diagram for EnvCellState:

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

Public Attributes
double	some_heterogeneous_parameter
double	some_het_parameter
Public Attributes inherited from Utopia::Models::Environment::BaseEnvCellState
SpaceVec	position
	Cached barycenter of the cell.

Additional Inherited Members
Public Types inherited from Utopia::Models::Environment::BaseEnvCellState
using	SpaceVec = SpaceVecType< 2 >

Detailed Description

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

Create a non-abstract EnvCellState.

Note

This is used to allow standalone operation.

Constructor & Destructor Documentation

EnvCellState() [1/2]

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

inline

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

~EnvCellState() [1/2]

EnvCellState::~EnvCellState ( )

default

EnvCellState() [2/2]

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

inline

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

~EnvCellState() [2/2]

EnvCellState::~EnvCellState ( )

inline

{ }

Member Function Documentation

get_env() [1/2]

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

inlinevirtual

Getter.

Implements Utopia::Models::Environment::BaseEnvCellState.

                                               {
        if (key == "some_het_parameter") {
            return some_het_parameter;
        }
        throw std::invalid_argument("No access method to the key '" 
                                    + key + "' in EnvCellState!");
    }

get_env() [2/2]

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

inlineoverridevirtual

Getter.

Implements Utopia::Models::Environment::BaseEnvCellState.

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

set_env() [1/2]

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

inlinevirtual

Setter.

Implements Utopia::Models::Environment::BaseEnvCellState.

                                                            {
        if (key == "some_het_parameter") {
            some_het_parameter = value;
            return;
        }
        throw std::invalid_argument("No setter method to the key '"
                                    + key + "' in EnvCellState!");
    }

set_env() [2/2]

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

inlineoverridevirtual

Setter.

Implements Utopia::Models::Environment::BaseEnvCellState.

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

Member Data Documentation

some_het_parameter

double EnvCellState::some_het_parameter

some_heterogeneous_parameter

double EnvCellState::some_heterogeneous_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