FireSTARR
Loading...
Searching...
No Matches
fs::MapObserver< T > Class Template Referenceabstract

An IObserver that tracks notification data using a GridMap. More...

#include <Observer.h>

Inheritance diagram for fs::MapObserver< T >:
Collaboration diagram for fs::MapObserver< T >:

Public Member Functions

 MapObserver (const MapObserver &rhs)=delete
 
 MapObserver (MapObserver &&rhs)=delete
 
MapObserver & operator= (const MapObserver &rhs)=delete
 
MapObserver & operator= (MapObserver &&rhs)=delete
 
 MapObserver (const Scenario &scenario, T nodata, string suffix)
 Keeps observations in a map.
 
virtual T getValue (const Event &event) const =0
 Function that returns the value we care about regarding the Event.
 
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
 

Protected Attributes

GridMap< T > map_ {}
 Map of observations.
 
const Scenario & scenario_
 Scenario being observed.
 

Private Attributes

string suffix_
 Suffix to append to file during save.
 

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

Detailed Description

template<typename T>
class fs::MapObserver< T >

An IObserver that tracks notification data using a GridMap.

Template Parameters
TType of map that is being tracked

Constructor & Destructor Documentation

◆ MapObserver()

template<typename T >
fs::MapObserver< T >::MapObserver ( const Scenario & scenario,
T nodata,
string suffix )
inline

Keeps observations in a map.

Parameters
scenarioScenario to observe
nodataValue to use for no data
suffixSuffix to use on saved file

Member Function Documentation

◆ getValue()

template<typename T >
virtual T fs::MapObserver< T >::getValue ( const Event & event) const
nodiscardpure virtual

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

Parameters
event
Returns

Implemented in fs::ArrivalObserver, fs::IntensityObserver, and fs::SourceObserver.

Here is the caller graph for this function:

◆ handleEvent()

template<typename T >
void fs::MapObserver< T >::handleEvent ( const Event & event)
inlineoverridevirtual

Handle given event.

Parameters
eventEvent to handle

Implements fs::IObserver.

Here is the call graph for this function:

◆ reset()

template<typename T >
void fs::MapObserver< T >::reset ( )
inlineoverridevirtualnoexcept

Clear all observations.

Implements fs::IObserver.

◆ save()

template<typename T >
FileList fs::MapObserver< T >::save ( const string_view dir,
const string_view base_name ) const
inlinenodiscardoverridevirtual

Save observations.

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

Implements fs::IObserver.

Here is the call graph for this function:

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