pops-core  0.9
PoPS (Pest or Pathogen Spread) Model Core C++ library
Public Member Functions | List of all members
pops::SimpleTreatment< IntegerRaster, FloatRaster > Class Template Reference

Simple treatment class. More...

#include <treatments.hpp>

Inheritance diagram for pops::SimpleTreatment< IntegerRaster, FloatRaster >:
Inheritance graph
[legend]
Collaboration diagram for pops::SimpleTreatment< IntegerRaster, FloatRaster >:
Collaboration graph
[legend]

Public Member Functions

 SimpleTreatment (const FloatRaster &map, unsigned start, TreatmentApplication treatment_application)
 
bool should_start (unsigned step) override
 
bool should_end (unsigned) override
 
void apply_treatment (IntegerRaster &infected, std::vector< IntegerRaster > &exposed, IntegerRaster &susceptible, IntegerRaster &resistant, IntegerRaster &total_hosts, const std::vector< std::vector< int >> &suitable_cells) override
 
void end_treatment (IntegerRaster &, IntegerRaster &, const std::vector< std::vector< int >> &) override
 
- Public Member Functions inherited from pops::BaseTreatment< IntegerRaster, FloatRaster >
 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 ~AbstractTreatment ()
 

Additional Inherited Members

- Protected Attributes inherited from pops::BaseTreatment< IntegerRaster, FloatRaster >
unsigned start_step_
 
unsigned end_step_
 
FloatRaster map_
 
TreatmentApplication application_
 

Detailed Description

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

Simple treatment class.

Removes percentage (given by treatment efficiency) of infected and susceptible host (e.g. cut down trees).

Definition at line 157 of file treatments.hpp.

Constructor & Destructor Documentation

◆ SimpleTreatment()

template<typename IntegerRaster , typename FloatRaster >
pops::SimpleTreatment< IntegerRaster, FloatRaster >::SimpleTreatment ( const FloatRaster &  map,
unsigned  start,
TreatmentApplication  treatment_application 
)
inline

Definition at line 160 of file treatments.hpp.

Member Function Documentation

◆ apply_treatment()

template<typename IntegerRaster , typename FloatRaster >
void pops::SimpleTreatment< IntegerRaster, FloatRaster >::apply_treatment ( IntegerRaster &  infected,
std::vector< IntegerRaster > &  exposed,
IntegerRaster &  susceptible,
IntegerRaster &  resistant,
IntegerRaster &  total_hosts,
const std::vector< std::vector< int >> &  suitable_cells 
)
inlineoverridevirtual

◆ end_treatment()

template<typename IntegerRaster , typename FloatRaster >
void pops::SimpleTreatment< IntegerRaster, FloatRaster >::end_treatment ( IntegerRaster &  ,
IntegerRaster &  ,
const std::vector< std::vector< int >> &   
)
inlineoverridevirtual

◆ should_end()

template<typename IntegerRaster , typename FloatRaster >
bool pops::SimpleTreatment< IntegerRaster, FloatRaster >::should_end ( unsigned  )
inlineoverridevirtual

◆ should_start()

template<typename IntegerRaster , typename FloatRaster >
bool pops::SimpleTreatment< IntegerRaster, FloatRaster >::should_start ( unsigned  step)
inlineoverridevirtual

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