FireSTARR
Loading...
Searching...
No Matches
fs::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::IObserver:

Public Member Functions

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

Static Public Member Functions

static string makeName (const string_view base_name, const string_view 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::IObserver::handleEvent ( const Event & event)
pure virtual

Handle given event.

Parameters
eventEvent to handle
Returns
None

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

◆ makeName()

string fs::IObserver::makeName ( const string_view base_name,
const string_view 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::IObserver::reset ( )
pure virtual

◆ save()

virtual FileList fs::IObserver::save ( const string_view dir,
const string_view base_name ) const
pure virtual

Save observations.

Parameters
dirDirectory to save to
base_nameBase file name to save to
Returns
FileList of file names saved to

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


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