FireSTARR
Loading...
Searching...
No Matches
fs::ArrivalObserver Class Referencefinal

Tracks when fire initially arrives in a Cell. More...

#include <Observer.h>

Inheritance diagram for fs::ArrivalObserver:
Collaboration diagram for fs::ArrivalObserver:

Public Member Functions

 ArrivalObserver (const ArrivalObserver &rhs)=delete
 
 ArrivalObserver (ArrivalObserver &&rhs)=delete
 
ArrivalObserver & operator= (const ArrivalObserver &rhs)=delete
 
ArrivalObserver & operator= (ArrivalObserver &&rhs)=delete
 
 ArrivalObserver (const Scenario &scenario)
 Constructor.
 
DurationSize getValue (const Event &event) const noexcept override
 Function that returns the value we care about regarding the Event.
 
- Public Member Functions inherited from fs::MapObserver< DurationSize >
 MapObserver (const MapObserver &rhs)=delete
 
 MapObserver (MapObserver &&rhs)=delete
 
 MapObserver (const Scenario &scenario, DurationSize nodata, string suffix)
 Keeps observations in a map.
 
MapObserver & operator= (const MapObserver &rhs)=delete
 
MapObserver & operator= (MapObserver &&rhs)=delete
 
void handleEvent (const Event &event) override
 Handle given event.
 
FileList save (const string_view dir, const string_view base_name) const override
 Save observations.
 
void reset () noexcept override
 Clear all observations.
 
- Public Member Functions inherited from fs::IObserver
 IObserver (const IObserver &rhs)=delete
 
 IObserver (IObserver &&rhs)=delete
 
IObserver & operator= (const IObserver &rhs)=delete
 
IObserver & operator= (IObserver &&rhs)=delete
 

Additional Inherited Members

- Static Public Member Functions inherited from fs::IObserver
static string makeName (const string_view base_name, const string_view suffix)
 Make name to save file as.
 
- Protected Member Functions inherited from fs::IObserver
- Protected Attributes inherited from fs::MapObserver< DurationSize >
GridMap< DurationSize > map_
 Map of observations.
 
const Scenario & scenario_
 Scenario being observed.
 

Detailed Description

Tracks when fire initially arrives in a Cell.

Constructor & Destructor Documentation

◆ ArrivalObserver()

fs::ArrivalObserver::ArrivalObserver ( const Scenario & scenario)
explicit

Constructor.

Parameters
scenarioScenario to track

Member Function Documentation

◆ getValue()

DurationSize fs::ArrivalObserver::getValue ( const Event & event) const
nodiscardoverridevirtualnoexcept

Function that returns the value we care about regarding the Event.

Parameters
event
Returns

Implements fs::MapObserver< DurationSize >.


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