Helper class for reproduction within a breeding season. More...

Public Member Functions
	BreedingSeason (const int breeding_season_start, const int breeding_season_length)
	Constructor. More...

bool	is_in_season (const int day) const
	Whether given day (0=Jan 1st) is in the breeding season. More...

double	annual_to_daily_rate (const double annual) const
	Convert an annual reproduction rate to a daily one in season. More...

bool	operator== (const BreedingSeason &other) const
	Whether all member variables are the same in the other object. More...

Detailed Description

Helper class for reproduction within a breeding season.

Constructor & Destructor Documentation

BreedingSeason::BreedingSeason	(	const int	breeding_season_start,
		const int	breeding_season_length
	)

Constructor.

Parameters

breeding_season_start	The day of the year (0=Jan 1st) at which the breeding season starts.
breeding_season_length	Length of the breeding season in days [1–365].

double BreedingSeason::annual_to_daily_rate ( const double annual ) const

Convert an annual reproduction rate to a daily one in season.

bool BreedingSeason::is_in_season ( const int day ) const

Whether given day (0=Jan 1st) is in the breeding season.

Exceptions

std::invalid_argument If day is not in [0,364].

bool Fauna::BreedingSeason::operator== ( const BreedingSeason & other ) const

inline

Whether all member variables are the same in the other object.

int Fauna::BreedingSeason::length

private

int Fauna::BreedingSeason::start

private

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