#include <config.hpp>

Collaboration diagram for pops::Config:

[legend]

Public Member Functions
void	create_schedules ()

const Scheduler &	scheduler () const

const std::vector< bool > &	spread_schedule () const

const std::vector< bool > &	mortality_schedule () const

const std::vector< bool > &	lethal_schedule () const

const std::vector< bool > &	spread_rate_schedule () const

const std::vector< bool > &	quarantine_schedule () const

const std::vector< bool > &	output_schedule () const

unsigned	num_mortality_steps ()

unsigned	num_lethal ()

unsigned	rate_num_steps ()

unsigned	quarantine_num_steps ()

const Date &	date_start () const

template<typename... Args>
void	set_date_start (Args &&... args)

const Date &	date_end () const

template<typename... Args>
void	set_date_end (Args &&... args)

StepUnit	step_unit () const

void	set_step_unit (StepUnit step_unit)

void	set_step_unit (const std::string &text)

unsigned	step_num_units () const

void	set_step_num_units (unsigned step_num_units)

void	set_season_start_end_month (int start, int end)

void	set_season_start_end_month (const std::string &start, const std::string &end)

Public Attributes
int	random_seed {0}

int	rows {0}

int	cols {0}

double	ew_res {0}

double	ns_res {0}

BBox< double >	bbox

bool	generate_stochasticity {true}

bool	establishment_stochasticity {true}

bool	movement_stochasticity {true}

bool	deterministic {false}

double	establishment_probability {0}

bool	use_lethal_temperature {false}

double	lethal_temperature {-273.15}

int	lethal_temperature_month {0}

bool	weather {false}

double	reproductive_rate {0}

std::string	model_type

int	latency_period_steps

std::string	natural_kernel_type

double	natural_scale {0}

std::string	natural_direction

double	natural_kappa {0}

bool	use_anthropogenic_kernel {false}

double	percent_natural_dispersal {1}

std::string	anthro_kernel_type

double	anthro_scale {0}

std::string	anthro_direction

double	network_min_time {0}

double	network_max_time {0}

double	network_speed {0}

double	anthro_kappa {0}

double	shape {1.0}

bool	use_treatments {false}

bool	use_mortality {false}

std::string	mortality_frequency

unsigned	mortality_frequency_n

double	mortality_rate {0}

int	mortality_time_lag {0}

bool	use_quarantine {false}

std::string	quarantine_frequency

unsigned	quarantine_frequency_n

bool	use_movements {false}

std::vector< unsigned >	movement_schedule

double	dispersal_percentage {0.99}

std::string	output_frequency

unsigned	output_frequency_n

bool	use_spreadrates {true}

std::string	spreadrate_frequency

unsigned	spreadrate_frequency_n

bool	use_overpopulation_movements {false}

double	overpopulation_percentage {0}

double	leaving_percentage {0}

double	leaving_scale_coefficient {1}

Detailed Description

Definition at line 34 of file config.hpp.

Member Function Documentation

◆ create_schedules()

void pops::Config::create_schedules ( )

inline

Definition at line 101 of file config.hpp.

Here is the call graph for this function:

◆ date_end()

const Date& pops::Config::date_end ( ) const

inline

Definition at line 240 of file config.hpp.

◆ date_start()

const Date& pops::Config::date_start ( ) const

inline

Definition at line 229 of file config.hpp.

◆ lethal_schedule()

const std::vector<bool>& pops::Config::lethal_schedule ( ) const

inline

Definition at line 147 of file config.hpp.

Here is the caller graph for this function:

◆ mortality_schedule()

const std::vector<bool>& pops::Config::mortality_schedule ( ) const

inline

Definition at line 139 of file config.hpp.

Here is the caller graph for this function:

◆ num_lethal()

unsigned pops::Config::num_lethal ( )

inline

Definition at line 196 of file config.hpp.

Here is the call graph for this function:

◆ num_mortality_steps()

unsigned pops::Config::num_mortality_steps ( )

inline

Definition at line 188 of file config.hpp.

Here is the call graph for this function:

◆ output_schedule()

const std::vector<bool>& pops::Config::output_schedule ( ) const

inline

Definition at line 180 of file config.hpp.

◆ quarantine_num_steps()

unsigned pops::Config::quarantine_num_steps ( )

inline

Definition at line 218 of file config.hpp.

Here is the call graph for this function:

◆ quarantine_schedule()

const std::vector<bool>& pops::Config::quarantine_schedule ( ) const

inline

Definition at line 169 of file config.hpp.

Here is the caller graph for this function:

◆ rate_num_steps()

unsigned pops::Config::rate_num_steps ( )

inline

Definition at line 207 of file config.hpp.

Here is the call graph for this function:

◆ scheduler()

const Scheduler& pops::Config::scheduler ( ) const

inline

Definition at line 123 of file config.hpp.

◆ set_date_end()

template<typename... Args>

void pops::Config::set_date_end ( Args &&... args )

inline

Definition at line 246 of file config.hpp.

◆ set_date_start()

template<typename... Args>

void pops::Config::set_date_start ( Args &&... args )

inline

Definition at line 235 of file config.hpp.

◆ set_season_start_end_month() [1/2]

void pops::Config::set_season_start_end_month	(	const std::string &	start,
		const std::string &	end
	)

inline

Definition at line 283 of file config.hpp.

◆ set_season_start_end_month() [2/2]

void pops::Config::set_season_start_end_month	(	int	start,
		int	end
	)

inline

Definition at line 277 of file config.hpp.

◆ set_step_num_units()

void pops::Config::set_step_num_units ( unsigned step_num_units )

inline

Definition at line 271 of file config.hpp.

Here is the call graph for this function:

◆ set_step_unit() [1/2]

void pops::Config::set_step_unit ( const std::string & text )

inline

Definition at line 261 of file config.hpp.

Here is the call graph for this function:

◆ set_step_unit() [2/2]

void pops::Config::set_step_unit ( StepUnit step_unit )

inline

Definition at line 256 of file config.hpp.

Here is the call graph for this function:

◆ spread_rate_schedule()

const std::vector<bool>& pops::Config::spread_rate_schedule ( ) const

inline

Definition at line 158 of file config.hpp.

Here is the caller graph for this function:

◆ spread_schedule()

const std::vector<bool>& pops::Config::spread_schedule ( ) const

inline

Definition at line 131 of file config.hpp.

Here is the caller graph for this function:

◆ step_num_units()

unsigned pops::Config::step_num_units ( ) const

inline

Definition at line 266 of file config.hpp.

Here is the caller graph for this function:

◆ step_unit()

StepUnit pops::Config::step_unit ( ) const

inline

Definition at line 251 of file config.hpp.

Here is the caller graph for this function:

Member Data Documentation

◆ anthro_direction

std::string pops::Config::anthro_direction

Definition at line 69 of file config.hpp.

◆ anthro_kappa

double pops::Config::anthro_kappa {0}

Definition at line 73 of file config.hpp.

◆ anthro_kernel_type

std::string pops::Config::anthro_kernel_type

Definition at line 67 of file config.hpp.

◆ anthro_scale

double pops::Config::anthro_scale {0}

Definition at line 68 of file config.hpp.

◆ bbox

BBox<double> pops::Config::bbox

Definition at line 44 of file config.hpp.

◆ cols

int pops::Config::cols {0}

Definition at line 41 of file config.hpp.

◆ deterministic

bool pops::Config::deterministic {false}

Definition at line 49 of file config.hpp.

◆ dispersal_percentage

double pops::Config::dispersal_percentage {0.99}

Definition at line 90 of file config.hpp.

◆ establishment_probability

double pops::Config::establishment_probability {0}

Definition at line 50 of file config.hpp.

◆ establishment_stochasticity

bool pops::Config::establishment_stochasticity {true}

Definition at line 47 of file config.hpp.

◆ ew_res

double pops::Config::ew_res {0}

Definition at line 42 of file config.hpp.

◆ generate_stochasticity

bool pops::Config::generate_stochasticity {true}

Definition at line 46 of file config.hpp.

◆ latency_period_steps

int pops::Config::latency_period_steps

Definition at line 59 of file config.hpp.

◆ leaving_percentage

double pops::Config::leaving_percentage {0}

Definition at line 98 of file config.hpp.

◆ leaving_scale_coefficient

double pops::Config::leaving_scale_coefficient {1}

Definition at line 99 of file config.hpp.

◆ lethal_temperature

double pops::Config::lethal_temperature {-273.15}

Definition at line 53 of file config.hpp.

◆ lethal_temperature_month

int pops::Config::lethal_temperature_month {0}

Definition at line 54 of file config.hpp.

◆ model_type

std::string pops::Config::model_type

Definition at line 58 of file config.hpp.

◆ mortality_frequency

std::string pops::Config::mortality_frequency

Definition at line 79 of file config.hpp.

◆ mortality_frequency_n

unsigned pops::Config::mortality_frequency_n

Definition at line 80 of file config.hpp.

◆ mortality_rate

double pops::Config::mortality_rate {0}

Definition at line 81 of file config.hpp.

◆ mortality_time_lag

int pops::Config::mortality_time_lag {0}

Definition at line 82 of file config.hpp.

◆ movement_schedule

std::vector<unsigned> pops::Config::movement_schedule

Definition at line 89 of file config.hpp.

◆ movement_stochasticity

bool pops::Config::movement_stochasticity {true}

Definition at line 48 of file config.hpp.

◆ natural_direction

std::string pops::Config::natural_direction

Definition at line 63 of file config.hpp.

◆ natural_kappa

double pops::Config::natural_kappa {0}

Definition at line 64 of file config.hpp.

◆ natural_kernel_type

std::string pops::Config::natural_kernel_type

Definition at line 61 of file config.hpp.

◆ natural_scale

double pops::Config::natural_scale {0}

Definition at line 62 of file config.hpp.

◆ network_max_time

double pops::Config::network_max_time {0}

Definition at line 71 of file config.hpp.

◆ network_min_time

double pops::Config::network_min_time {0}

Definition at line 70 of file config.hpp.

◆ network_speed

double pops::Config::network_speed {0}

Definition at line 72 of file config.hpp.

◆ ns_res

double pops::Config::ns_res {0}

Definition at line 43 of file config.hpp.

◆ output_frequency

std::string pops::Config::output_frequency

Definition at line 91 of file config.hpp.

◆ output_frequency_n

unsigned pops::Config::output_frequency_n

Definition at line 92 of file config.hpp.

◆ overpopulation_percentage

double pops::Config::overpopulation_percentage {0}

Definition at line 97 of file config.hpp.

◆ percent_natural_dispersal

double pops::Config::percent_natural_dispersal {1}

Definition at line 66 of file config.hpp.

◆ quarantine_frequency

std::string pops::Config::quarantine_frequency

Definition at line 85 of file config.hpp.

◆ quarantine_frequency_n

unsigned pops::Config::quarantine_frequency_n

Definition at line 86 of file config.hpp.

◆ random_seed

int pops::Config::random_seed {0}

Definition at line 38 of file config.hpp.

◆ reproductive_rate

double pops::Config::reproductive_rate {0}

Definition at line 56 of file config.hpp.

◆ rows

int pops::Config::rows {0}

Definition at line 40 of file config.hpp.

◆ shape

double pops::Config::shape {1.0}

Definition at line 74 of file config.hpp.

◆ spreadrate_frequency

std::string pops::Config::spreadrate_frequency

Definition at line 94 of file config.hpp.

◆ spreadrate_frequency_n

unsigned pops::Config::spreadrate_frequency_n

Definition at line 95 of file config.hpp.

◆ use_anthropogenic_kernel

bool pops::Config::use_anthropogenic_kernel {false}

Definition at line 65 of file config.hpp.

◆ use_lethal_temperature

bool pops::Config::use_lethal_temperature {false}

Definition at line 52 of file config.hpp.

◆ use_mortality

bool pops::Config::use_mortality {false}

Definition at line 78 of file config.hpp.

◆ use_movements

bool pops::Config::use_movements {false}

Definition at line 88 of file config.hpp.

◆ use_overpopulation_movements

bool pops::Config::use_overpopulation_movements {false}

Definition at line 96 of file config.hpp.

◆ use_quarantine

bool pops::Config::use_quarantine {false}

Definition at line 84 of file config.hpp.

◆ use_spreadrates

bool pops::Config::use_spreadrates {true}

Definition at line 93 of file config.hpp.

◆ use_treatments

bool pops::Config::use_treatments {false}

Definition at line 76 of file config.hpp.

◆ weather

bool pops::Config::weather {false}

Definition at line 55 of file config.hpp.

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

include/pops/config.hpp

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ create_schedules()

◆ date_end()

◆ date_start()

◆ lethal_schedule()

◆ mortality_schedule()

◆ num_lethal()

◆ num_mortality_steps()

◆ output_schedule()

◆ quarantine_num_steps()

◆ quarantine_schedule()

◆ rate_num_steps()

◆ scheduler()

◆ set_date_end()

◆ set_date_start()

◆ set_season_start_end_month() [1/2]

◆ set_season_start_end_month() [2/2]

◆ set_step_num_units()

◆ set_step_unit() [1/2]

◆ set_step_unit() [2/2]

◆ spread_rate_schedule()

◆ spread_schedule()

◆ step_num_units()

◆ step_unit()

Member Data Documentation

◆ anthro_direction

◆ anthro_kappa

◆ anthro_kernel_type

◆ anthro_scale

◆ bbox

◆ cols

◆ deterministic

◆ dispersal_percentage

◆ establishment_probability

◆ establishment_stochasticity

◆ ew_res

◆ generate_stochasticity

◆ latency_period_steps

◆ leaving_percentage

◆ leaving_scale_coefficient

◆ lethal_temperature

◆ lethal_temperature_month

◆ model_type

◆ mortality_frequency

◆ mortality_frequency_n

◆ mortality_rate

◆ mortality_time_lag

◆ movement_schedule

◆ movement_stochasticity

◆ natural_direction

◆ natural_kappa

◆ natural_kernel_type

◆ natural_scale

◆ network_max_time

◆ network_min_time

◆ network_speed

◆ ns_res

◆ output_frequency

◆ output_frequency_n

◆ overpopulation_percentage

◆ percent_natural_dispersal

◆ quarantine_frequency

◆ quarantine_frequency_n

◆ random_seed

◆ reproductive_rate

◆ rows

◆ shape

◆ spreadrate_frequency

◆ spreadrate_frequency_n

◆ use_anthropogenic_kernel

◆ use_lethal_temperature

◆ use_mortality

◆ use_movements

◆ use_overpopulation_movements

◆ use_quarantine

◆ use_spreadrates

◆ use_treatments