Function class constructing HerbivoreCohort objects. More...

Inheritance diagram for Fauna::CreateHerbivoreCohort:

Public Member Functions
	CreateHerbivoreCohort (const std::shared_ptr< const Hft > hft, const std::shared_ptr< const Parameters > parameters)
	Constructor. More...

virtual HerbivoreCohort	operator() (const double ind_per_km2, const int age_years, Sex sex) const
	Create a new object instance. More...

Public Member Functions inherited from Fauna::CreateHerbivoreCommon
const Hft &	get_hft () const
	The herbivore functional type. More...

const Parameters &	get_params () const
	Global simulation parameters. More...

Additional Inherited Members
Protected Member Functions inherited from Fauna::CreateHerbivoreCommon
	CreateHerbivoreCommon (const std::shared_ptr< const Hft > hft, const std::shared_ptr< const Parameters > parameters)
	Protected constructor. More...

double	get_body_condition (const int age_days) const
	Fat mass per maximum fat mass. More...

Protected Attributes inherited from Fauna::CreateHerbivoreCommon
const std::shared_ptr< const Hft >	hft

const std::shared_ptr< const Parameters >	parameters

Detailed Description

Function class constructing HerbivoreCohort objects.

Constructor & Destructor Documentation

Fauna::CreateHerbivoreCohort::CreateHerbivoreCohort	(	const std::shared_ptr< const Hft >	hft,
		const std::shared_ptr< const Parameters >	parameters
	)

inline

Constructor.

Protected constructor.

Exceptions

std::invalid_argument If hft==NULL or parameters==NULL

HerbivoreCohort CreateHerbivoreCohort::operator()	(	const double	ind_per_km2,
		const int	age_years,
		Sex	sex
	)		const

virtual

Create a new object instance.

Parameters

ind_per_km2	Individual density of the new cohort.
age_years	Age in years.
sex	Gender of the herbivore.

Exceptions

std::invalid_argument if ind_per_km2<=0.0 or age_years<0

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

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