Habitat output data for one time unit. More...

Public Member Functions
Aggregation Functionality
HabitatData &	merge (const HabitatData &other, const double this_weight, const double other_weight)
	Aggregate data of this object with another one. More...

void	reset ()
	Reset member variables to initial values. More...

Public Attributes
Fauna::HabitatForage	available_forage
	Available forage in the habitat. More...

Fauna::ForageMass	eaten_forage
	Forage mass [kgDM/km²/day] eaten by herbivores. More...

Fauna::HabitatEnvironment	environment
	Abiotic conditions in the habitat. More...

Detailed Description

Habitat output data for one time unit.

See also: The section on output classes in the MMM software design documentation.

Member Function Documentation

HabitatData & HabitatData::merge	(	const HabitatData &	other,
		const double	this_weight,
		const double	other_weight
	)

Aggregate data of this object with another one.

This does no calculations if the partners are the same object, or one of the weights is zero.

Parameters

other	The other object to be merged into this one.
this_weight	Weight of this object in average building.
other_weight	Weight of `other` in average building.

See also: Fauna::average(), Fauna::HabitatForage::merge(), Fauna::ForageValues::merge()

Exceptions

std::invalid_argument If either weight is not a positive number or if both are zero.

void Fauna::Output::HabitatData::reset ( )

inline

Reset member variables to initial values.

Fauna::HabitatForage Fauna::Output::HabitatData::available_forage

Available forage in the habitat.

Fauna::ForageMass Fauna::Output::HabitatData::eaten_forage

Forage mass [kgDM/km²/day] eaten by herbivores.

This is the sum of all forage that has been eaten by all herbivores together.

Fauna::HabitatEnvironment Fauna::Output::HabitatData::environment

Abiotic conditions in the habitat.

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

/home/docs/checkouts/readthedocs.org/user_builds/modular-megafauna-model/checkouts/latest/include/Fauna/Output/habitat_data.h
/home/docs/checkouts/readthedocs.org/user_builds/modular-megafauna-model/checkouts/latest/src/Fauna/Output/habitat_data.cpp