Fauna::CreateHerbivoreCommon Class Reference

Parent class for CreateHerbivoreCohort. More...

#include <create_herbivore_common.h>

Inheritance diagram for Fauna::CreateHerbivoreCommon:

Public Member Functions
const Hft &	get_hft () const
	The herbivore functional type. More...
const Parameters &	get_params () const
	Global simulation parameters. More...

Protected Member Functions
	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
const std::shared_ptr< const Hft >	hft
const std::shared_ptr< const Parameters >	parameters

Detailed Description

Parent class for CreateHerbivoreCohort.

This parent class simply provides some common functionality common to both child classes.

Constructor & Destructor Documentation

CreateHerbivoreCommon()

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

protected

Protected constructor.

Exceptions

std::invalid_argument

If hft==NULL or parameters==NULL

Member Function Documentation

get_body_condition()

double CreateHerbivoreCommon::get_body_condition ( const int  age_days ) const

protected

Fat mass per maximum fat mass.

get_hft()

const Hft & CreateHerbivoreCommon::get_hft

(

)

const

The herbivore functional type.

get_params()

const Parameters & CreateHerbivoreCommon::get_params

(

)

const

Global simulation parameters.

Member Data Documentation

hft

const std::shared_ptr<const Hft> Fauna::CreateHerbivoreCommon::hft

protected

parameters

const std::shared_ptr<const Parameters> Fauna::CreateHerbivoreCommon::parameters

protected

---

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_common.h
• /home/docs/checkouts/readthedocs.org/user_builds/modular-megafauna-model/checkouts/latest/src/Fauna/create_herbivore_common.cpp