fs::wx::FireWeather Class Reference

A stream of weather that gets used by a Scenario every Iteration. More...

#include <FireWeather.h>

Inheritance diagram for fs::wx::FireWeather:

Collaboration diagram for fs::wx::FireWeather:

Public Member Functions
virtual	~FireWeather ()
	Destructor.
	FireWeather (FireWeather &&rhs)=default
	Move constructor.
	FireWeather (const FireWeather &rhs)=delete
FireWeather &	operator= (FireWeather &&rhs) noexcept=default
	Move assignment.
FireWeather &	operator= (const FireWeather &rhs)=delete
const FwiWeather *	at (const DurationSize time) const
	Get FwiWeather for given time.
ThresholdSize	survivalProbability (const DurationSize time, const FuelCodeSize &in_fuel) const
	Probability of survival in given fuel at given time.
constexpr Day	minDate () const
	Minimum date present in FireWeather.
constexpr Day	maxDate () const
	Maximum date present in FireWeather.
constexpr size_t	weightedDsr () const noexcept
	Weighted Danger Severity Rating for the stream.
const vector< const FwiWeather * > *	getWeather ()
	Weather by hour by day.
	FireWeather (const set< const fuel::FuelType * > &used_fuels, Day min_date, Day max_date, vector< const FwiWeather * > *weather_by_hour_by_day)
	Constructor.

Private Attributes
const vector< const FwiWeather * > *	weather_by_hour_by_day_
	FwiWeather by hour by Day.
const SurvivalMap *	survival_probability_
	Probability of survival for fuels fuel at each time.
Day	min_date_
	Minimum date present in stream.
Day	max_date_
	Maximum date present in stream.
size_t	weighted_dsr_
	Weighted Danger Severity Rating for the stream.

Detailed Description

A stream of weather that gets used by a Scenario every Iteration.

Constructor & Destructor Documentation

FireWeather() [1/2]

fs::wx::FireWeather::FireWeather ( FireWeather && rhs )

default

Move constructor.

Parameters

rhs	FireWeather to move from

FireWeather() [2/2]

fs::wx::FireWeather::FireWeather	(	const set< const fuel::FuelType * > &	used_fuels,
		Day	min_date,
		Day	max_date,
		vector< const FwiWeather * > *	weather_by_hour_by_day )

Constructor.

Parameters

used_fuels	set of FuelTypes that are used in the simulation
min_date	Minimum date present in stream
max_date	Maximum date present in stream
weather_by_hour_by_day	FwiWeather by hour by Day

Member Function Documentation

at()

const FwiWeather * fs::wx::FireWeather::at ( const DurationSize time ) const

inlinenodiscard

Get FwiWeather for given time.

Parameters

time	Time to get weather for

Returns

FwiWeather for given time

Here is the caller graph for this function:

getWeather()

const vector< const FwiWeather * > * fs::wx::FireWeather::getWeather ( )

inlinenodiscard

Weather by hour by day.

Returns

Weather by hour by day

maxDate()

Day fs::wx::FireWeather::maxDate ( ) const

inlinenodiscardconstexpr

Maximum date present in FireWeather.

Returns

Maximum date present in FireWeather

Here is the caller graph for this function:

minDate()

Day fs::wx::FireWeather::minDate ( ) const

inlinenodiscardconstexpr

Minimum date present in FireWeather.

Returns

Minimum date present in FireWeather

Here is the caller graph for this function:

operator=()

FireWeather & fs::wx::FireWeather::operator= ( FireWeather && rhs )

defaultnoexcept

Move assignment.

Parameters

rhs	FireWeather to move from

Returns

This, after assignment

survivalProbability()

ThresholdSize fs::wx::FireWeather::survivalProbability ( const DurationSize time, const FuelCodeSize & in_fuel ) const

inlinenodiscard

Probability of survival in given fuel at given time.

Parameters

time	Time to get survival probability for
in_fuel	FuelCodeSize of FuelType to use

Returns

Probability of survival in given fuel at given time

weightedDsr()

size_t fs::wx::FireWeather::weightedDsr ( ) const

inlinenodiscardconstexprnoexcept

Weighted Danger Severity Rating for the stream.

Returns

Weighted Danger Severity Rating for the stream

Here is the caller graph for this function:

---

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

• firestarr/src/cpp/FireWeather.h
• firestarr/src/cpp/FireWeather.cpp