FireSTARR
Loading...
Searching...
No Matches
fs::sim::IObserver Class Referenceabstract

Interface for observers that get notified when cells burn so they can track things. More...

#include <Observer.h>

Inheritance diagram for fs::sim::IObserver:

Public Member Functions

 IObserver (const IObserver &rhs)=delete
 
 IObserver (IObserver &&rhs)=delete
 
IObserveroperator= (const IObserver &rhs)=delete
 
IObserveroperator= (IObserver &&rhs)=delete
 
virtual void handleEvent (const Event &event)=0
 Handle given event.
 
virtual void save (const string &dir, const string &base_name) const =0
 Save observations.
 
virtual void reset ()=0
 Clear all observations.
 

Static Public Member Functions

static string makeName (const string &base_name, const string &suffix)
 Make name to save file as.
 

Detailed Description

Interface for observers that get notified when cells burn so they can track things.

Member Function Documentation

◆ handleEvent()

virtual void fs::sim::IObserver::handleEvent ( const Event & event)
pure virtual

◆ makeName()

string fs::sim::IObserver::makeName ( const string & base_name,
const string & suffix )
static

Make name to save file as.

Parameters
base_nameBase file name
suffixSuffix to append
Returns
File name to use based on inputs
Here is the caller graph for this function:

◆ reset()

virtual void fs::sim::IObserver::reset ( )
pure virtual

◆ save()

virtual void fs::sim::IObserver::save ( const string & dir,
const string & base_name ) const
pure virtual

Save observations.

Parameters
dirDirectory to save to
base_nameBase file name to save to
Returns
None

Implemented in fs::sim::IntensityObserver, fs::sim::MapObserver< T >, fs::sim::MapObserver< CellIndex >, fs::sim::MapObserver< DurationSize >, and fs::sim::MapObserver< IntensitySize >.


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