pops::BaseTreatment< IntegerRaster, FloatRaster > Class Template Reference

Base treatment class. More...

#include <treatments.hpp>

Inheritance diagram for pops::BaseTreatment< IntegerRaster, FloatRaster >:

Collaboration diagram for pops::BaseTreatment< IntegerRaster, FloatRaster >:

Public Member Functions
	BaseTreatment (const FloatRaster &map, unsigned start, TreatmentApplication treatment_application)
unsigned	get_start () override
unsigned	get_end () override
void	apply_treatment_mortality (IntegerRaster &infected, const std::vector< std::vector< int >> &suitable_cells) override
Public Member Functions inherited from pops::AbstractTreatment< IntegerRaster, FloatRaster >
virtual bool	should_start (unsigned step)=0
virtual bool	should_end (unsigned step)=0
virtual void	apply_treatment (IntegerRaster &infected, std::vector< IntegerRaster > &exposed, IntegerRaster &susceptible, IntegerRaster &resistant, IntegerRaster &total_hosts, const std::vector< std::vector< int >> &spatial_indeices)=0
virtual void	end_treatment (IntegerRaster &susceptible, IntegerRaster &resistant, const std::vector< std::vector< int >> &spatial_indeices)=0
virtual	~AbstractTreatment ()

Protected Attributes
unsigned	start_step_
unsigned	end_step_
FloatRaster	map_
TreatmentApplication	application_

Detailed Description

template<typename IntegerRaster, typename FloatRaster>
class pops::BaseTreatment< IntegerRaster, FloatRaster >

Base treatment class.

Holds functions common between all treatment classes.

Definition at line 108 of file treatments.hpp.

Constructor & Destructor Documentation

BaseTreatment()

template<typename IntegerRaster , typename FloatRaster >

pops::BaseTreatment< IntegerRaster, FloatRaster >::BaseTreatment ( const FloatRaster &  map, unsigned  start, TreatmentApplication  treatment_application  )

inline

Definition at line 117 of file treatments.hpp.

Member Function Documentation

apply_treatment_mortality()

template<typename IntegerRaster , typename FloatRaster >

void pops::BaseTreatment< IntegerRaster, FloatRaster >::apply_treatment_mortality ( IntegerRaster &  infected, const std::vector< std::vector< int >> &  suitable_cells  )

inlineoverridevirtual

Implements pops::AbstractTreatment< IntegerRaster, FloatRaster >.

Definition at line 134 of file treatments.hpp.

get_end()

template<typename IntegerRaster , typename FloatRaster >

unsigned pops::BaseTreatment< IntegerRaster, FloatRaster >::get_end ( )

inlineoverridevirtual

Implements pops::AbstractTreatment< IntegerRaster, FloatRaster >.

Definition at line 130 of file treatments.hpp.

get_start()

template<typename IntegerRaster , typename FloatRaster >

unsigned pops::BaseTreatment< IntegerRaster, FloatRaster >::get_start ( )

inlineoverridevirtual

Implements pops::AbstractTreatment< IntegerRaster, FloatRaster >.

Definition at line 126 of file treatments.hpp.

Member Data Documentation

application_

template<typename IntegerRaster , typename FloatRaster >

TreatmentApplication pops::BaseTreatment< IntegerRaster, FloatRaster >::application_

protected

Definition at line 114 of file treatments.hpp.

end_step_

template<typename IntegerRaster , typename FloatRaster >

unsigned pops::BaseTreatment< IntegerRaster, FloatRaster >::end_step_

protected

Definition at line 112 of file treatments.hpp.

map_

template<typename IntegerRaster , typename FloatRaster >

FloatRaster pops::BaseTreatment< IntegerRaster, FloatRaster >::map_

protected

Definition at line 113 of file treatments.hpp.

start_step_

template<typename IntegerRaster , typename FloatRaster >

unsigned pops::BaseTreatment< IntegerRaster, FloatRaster >::start_step_

protected

Definition at line 111 of file treatments.hpp.

---

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

• include/pops/treatments.hpp