fs::sim::IntensityObserver Class Reference

Tracks the intensity that Cells burn at. More...

#include <Observer.h>

Inheritance diagram for fs::sim::IntensityObserver:

Collaboration diagram for fs::sim::IntensityObserver:

Public Member Functions
	IntensityObserver (const IntensityObserver &rhs)=delete
	IntensityObserver (IntensityObserver &&rhs)=delete
IntensityObserver &	operator= (const IntensityObserver &rhs)=delete
IntensityObserver &	operator= (IntensityObserver &&rhs)=delete
	IntensityObserver (const Scenario &scenario) noexcept
	Constructor.
IntensitySize	getValue (const Event &event) const noexcept override
	Function that returns the value we care about regarding the Event.
void	save (const string &dir, const string &base_name) const override
	Save observations.
Public Member Functions inherited from fs::sim::MapObserver< IntensitySize >
	MapObserver (const MapObserver &rhs)=delete
	MapObserver (MapObserver &&rhs)=delete
	MapObserver (const Scenario &scenario, IntensitySize 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.
void	save (const string &dir, const string &base_name) const override
	Save observations.
void	reset () noexcept override
	Clear all observations.
Public Member Functions inherited from fs::sim::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::sim::IObserver
static string	makeName (const string &base_name, const string &suffix)
	Make name to save file as.
Protected Member Functions inherited from fs::sim::IObserver
Protected Attributes inherited from fs::sim::MapObserver< IntensitySize >
unique_ptr< data::GridMap< IntensitySize > >	map_
	Map of observations.
const Scenario &	scenario_
	Scenario being observed.
string	suffix_
	Suffix to append to file during save.

Detailed Description

Tracks the intensity that Cells burn at.

Constructor & Destructor Documentation

IntensityObserver()

fs::sim::IntensityObserver::IntensityObserver ( const Scenario & scenario )

explicitnoexcept

Constructor.

Parameters

scenario	Scenario to observe
suffix	Suffix to append to output file

Member Function Documentation

getValue()

IntensitySize fs::sim::IntensityObserver::getValue ( const Event & event ) const

nodiscardoverridevirtualnoexcept

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

Parameters

event

Returns

Implements fs::sim::MapObserver< IntensitySize >.

save()

void fs::sim::IntensityObserver::save ( const string & dir, const string & base_name ) const

overridevirtual

Save observations.

Parameters

dir	Directory to save to
base_name	Base file name to save to

Implements fs::sim::IObserver.

Here is the call graph for this function:

---

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

• firestarr/src/cpp/Observer.h
• firestarr/src/cpp/Observer.cpp