Tracks source Cell that fire arrived in Cell from. More...

#include <Observer.h>

Inheritance diagram for fs::sim::SourceObserver:

[legend]

Collaboration diagram for fs::sim::SourceObserver:

[legend]

Public Member Functions
	SourceObserver (const SourceObserver &rhs)=delete

	SourceObserver (SourceObserver &&rhs)=delete

SourceObserver &	operator= (const SourceObserver &rhs)=delete

SourceObserver &	operator= (SourceObserver &&rhs)=delete

	SourceObserver (const Scenario &scenario)
	Constructor.

CellIndex	getValue (const Event &event) const noexcept override
	Function that returns the value we care about regarding the Event.

Public Member Functions inherited from fs::sim::MapObserver< CellIndex >
	MapObserver (const MapObserver &rhs)=delete

	MapObserver (MapObserver &&rhs)=delete

	MapObserver (const Scenario &scenario, CellIndex 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< CellIndex >
unique_ptr< data::GridMap< CellIndex > >	map_
	Map of observations.

const Scenario &	scenario_
	Scenario being observed.

string	suffix_
	Suffix to append to file during save.

Detailed Description

Tracks source Cell that fire arrived in Cell from.

Constructor & Destructor Documentation

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

explicit

Constructor.

Parameters

scenario Scenario to track

CellIndex fs::sim::SourceObserver::getValue ( const Event & event ) const

nodiscardoverridevirtualnoexcept

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

Parameters

event

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