The type of a cell's state. More...

#include <CopyMeGrid.hh>

Public Member Functions
	CellState (const DataIO::Config &cfg)
	Construct the cell state from a configuration.

template<class RNG >
	CellState (const DataIO::Config &cfg, const std::shared_ptr< RNG > &rng)
	Construct the cell state from a configuration and an RNG.

Public Attributes
double	some_state
	A useful documentation string.

int	some_trait
	Another useful documentation string, yeah.

bool	is_a_vip_cell
	Whether this cell is very important.

Detailed Description

The type of a cell's state.

Constructor & Destructor Documentation

◆ CellState() [1/2]

Utopia::Models::CopyMeGrid::CellState::CellState ( const DataIO::Config & cfg )

inline

Construct the cell state from a configuration.

    :
        some_state(get_as<double>("some_state", cfg)),
        some_trait(get_as<int>("some_trait", cfg)),
        is_a_vip_cell(false)
    {}

◆ CellState() [2/2]

template<class RNG >

Utopia::Models::CopyMeGrid::CellState::CellState	(	const DataIO::Config &	cfg,
		const std::shared_ptr< RNG > &	rng
	)

inline

Construct the cell state from a configuration and an RNG.

    :
        // Use the config constructor to get the values
        CellState(cfg)
    {
        // Do some more things using the random number generator
        // There is the possibility to set a random initial trait
        if (cfg["random_initial_trait"]) {
            if (not get_as<bool>("random_initial_trait", cfg)) {
                // Is set, but is false. Just return:
                return;
            }
 
            // Choose a random value between 0 and the current value
            some_trait = std::uniform_int_distribution(0, some_trait)(*rng);
        }
        // else: the config option was not available
    }

Member Data Documentation

◆ is_a_vip_cell

bool Utopia::Models::CopyMeGrid::CellState::is_a_vip_cell

Whether this cell is very important.

◆ some_state

double Utopia::Models::CopyMeGrid::CellState::some_state

A useful documentation string.

◆ some_trait

int Utopia::Models::CopyMeGrid::CellState::some_trait

Another useful documentation string, yeah.

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

src/utopia/models/CopyMeGrid/CopyMeGrid.hh

Public Member Functions

Public Attributes