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

Abstract interface for treatment classes. More...

#include <treatments.hpp>

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

Public Member Functions
virtual unsigned	get_start ()=0
virtual unsigned	get_end ()=0
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 void	apply_treatment_mortality (IntegerRaster &infected, const std::vector< std::vector< int >> &spatial_indeices)=0
virtual	~AbstractTreatment ()

Detailed Description

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

Abstract interface for treatment classes.

The class is meant for better internal code layout and, at this point, it is not meant as a universal matured interface for treatments. Functions apply_treatment and end_treatment are examples where we account for the current concrete classes and will introduce more general set of parameters only when needed for additional classes.

Definition at line 79 of file treatments.hpp.

Constructor & Destructor Documentation

~AbstractTreatment()

template<typename IntegerRaster , typename FloatRaster >

virtual pops::AbstractTreatment< IntegerRaster, FloatRaster >::~AbstractTreatment ( )

inlinevirtual

Definition at line 100 of file treatments.hpp.

Member Function Documentation

apply_treatment()

template<typename IntegerRaster , typename FloatRaster >

virtual void pops::AbstractTreatment< IntegerRaster, FloatRaster >::apply_treatment ( IntegerRaster &  infected, std::vector< IntegerRaster > &  exposed, IntegerRaster &  susceptible, IntegerRaster &  resistant, IntegerRaster &  total_hosts, const std::vector< std::vector< int >> &  spatial_indeices  )

pure virtual

Implemented in pops::PesticideTreatment< IntegerRaster, FloatRaster >, and pops::SimpleTreatment< IntegerRaster, FloatRaster >.

apply_treatment_mortality()

template<typename IntegerRaster , typename FloatRaster >

virtual void pops::AbstractTreatment< IntegerRaster, FloatRaster >::apply_treatment_mortality ( IntegerRaster &  infected, const std::vector< std::vector< int >> &  spatial_indeices  )

pure virtual

Implemented in pops::BaseTreatment< IntegerRaster, FloatRaster >.

end_treatment()

template<typename IntegerRaster , typename FloatRaster >

virtual void pops::AbstractTreatment< IntegerRaster, FloatRaster >::end_treatment ( IntegerRaster &  susceptible, IntegerRaster &  resistant, const std::vector< std::vector< int >> &  spatial_indeices  )

pure virtual

Implemented in pops::PesticideTreatment< IntegerRaster, FloatRaster >, and pops::SimpleTreatment< IntegerRaster, FloatRaster >.

get_end()

template<typename IntegerRaster , typename FloatRaster >

virtual unsigned pops::AbstractTreatment< IntegerRaster, FloatRaster >::get_end ( )

pure virtual

Implemented in pops::BaseTreatment< IntegerRaster, FloatRaster >.

get_start()

template<typename IntegerRaster , typename FloatRaster >

virtual unsigned pops::AbstractTreatment< IntegerRaster, FloatRaster >::get_start ( )

pure virtual

Implemented in pops::BaseTreatment< IntegerRaster, FloatRaster >.

should_end()

template<typename IntegerRaster , typename FloatRaster >

virtual bool pops::AbstractTreatment< IntegerRaster, FloatRaster >::should_end ( unsigned  step )

pure virtual

Implemented in pops::SimpleTreatment< IntegerRaster, FloatRaster >, and pops::PesticideTreatment< IntegerRaster, FloatRaster >.

should_start()

template<typename IntegerRaster , typename FloatRaster >

virtual bool pops::AbstractTreatment< IntegerRaster, FloatRaster >::should_start ( unsigned  step )

pure virtual

Implemented in pops::PesticideTreatment< IntegerRaster, FloatRaster >, and pops::SimpleTreatment< IntegerRaster, FloatRaster >.

---

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

• include/pops/treatments.hpp