Utopia::Models::Environment::BaseEnvCellState Struct Reference

Base type for environment cell states. More...

#include <Environment.hh>

Inheritance diagram for Utopia::Models::Environment::BaseEnvCellState:

Public Types
using	SpaceVec = SpaceVecType< 2 >

Public Member Functions
virtual	~BaseEnvCellState ()=default
virtual double	get_env (const std::string &) const =0
	Get an environment variable. More...
virtual void	set_env (const std::string &, const double &)=0
	Set an environment variable. More...

Public Attributes
SpaceVec	position
	Cached barycenter of the cell. More...

Detailed Description

Base type for environment cell states.

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

Member Typedef Documentation

SpaceVec

using Utopia::Models::Environment::BaseEnvCellState::SpaceVec = SpaceVecType<2>

Constructor & Destructor Documentation

~BaseEnvCellState()

virtual Utopia::Models::Environment::BaseEnvCellState::~BaseEnvCellState ( )

virtualdefault

Member Function Documentation

get_env()

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

pure virtual

Get an environment variable.

Implemented in EnvCellState, EnvCellState, and Utopia::Models::Environment::DummyEnvCellState.

set_env()

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

pure virtual

Set an environment variable.

Implemented in EnvCellState, EnvCellState, and Utopia::Models::Environment::DummyEnvCellState.

Member Data Documentation

position

SpaceVec Utopia::Models::Environment::BaseEnvCellState::position

Cached barycenter of the cell.

---

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

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