fs::wx::Startup Class Reference

Startup values to initialize a weather stream calculation with. More...

#include <Startup.h>

Collaboration diagram for fs::wx::Startup:

Public Member Functions
constexpr const string &	station () const noexcept
	Station providing the Startup values.
constexpr const tm &	generated () const noexcept
	Time the Startup value is for.
constexpr const topo::Point &	point () const noexcept
	Point the Startup value is for.
constexpr MathSize	distanceFrom () const noexcept
	Distance Startup value location is from the requested location (m)
constexpr const Ffmc &	ffmc () const noexcept
	Fine Fuel Moisture Code.
constexpr const Dmc &	dmc () const noexcept
	Duff Moisture Code.
constexpr const Dc &	dc () const noexcept
	Drought Code.
constexpr const Precipitation &	apcpPrev () const noexcept
	Accumulated Precipitation from noon yesterday to start of hourly weather (mm)
constexpr bool	isOverridden () const noexcept
	Whether or not any Startup values were overridden.
	Startup (string station, const tm &generated, const topo::Point &point, MathSize distance_from, const Ffmc &ffmc, const Dmc &dmc, const Dc &dc, const Precipitation &apcp_prev, bool overridden) noexcept
	Constructor.
	Startup (Startup &&rhs) noexcept=default
	Move constructor.
	Startup (const Startup &rhs)=default
	Copy constructor.
Startup &	operator= (Startup &&rhs) noexcept=default
	Move assignment operator.
Startup &	operator= (const Startup &rhs)=default
	Copy assignment operator.
	~Startup ()=default
	Destructor.

Private Attributes
string	station_
	Station indices are from.
tm	generated_
	When these indices were observed.
topo::Point	point_
	Point this represents.
MathSize	distance_from_
	Distance actual point for this is from represented Point (m)
Ffmc	ffmc_
	Fine Fuel Moisture Code.
Dmc	dmc_
	Duff Moisture Code.
Dc	dc_
	Drought code.
Precipitation	apcp_prev_
	Accumulated Precipitation from noon yesterday to start of hourly weather (mm)
bool	is_overridden_
	Whether or not any of the indices have been overridden.

Detailed Description

Startup values to initialize a weather stream calculation with.

Constructor & Destructor Documentation

Startup() [1/3]

fs::wx::Startup::Startup ( string station, const tm & generated, const topo::Point & point, MathSize distance_from, const Ffmc & ffmc, const Dmc & dmc, const Dc & dc, const Precipitation & apcp_prev, bool overridden )

noexcept

Constructor.

Parameters

station	Station indices are from
generated	Date/Time indices are from
point	Point indices were requested for
distance_from	Distance from requested point the weather station is (m)
ffmc	Fine Fuel Moisture Code
dmc	Duff Moisture Code
dc	Drought Code
apcp_prev	Accumulated Precipitation from noon yesterday to start of hourly weather (mm)
overridden	whether or not any Startup values were overridden

Startup() [2/3]

fs::wx::Startup::Startup ( Startup && rhs )

defaultnoexcept

Move constructor.

Parameters

rhs	Startup to move from

Startup() [3/3]

fs::wx::Startup::Startup ( const Startup & rhs )

default

Copy constructor.

Parameters

rhs	Startup to copy from

Member Function Documentation

apcpPrev()

const Precipitation & fs::wx::Startup::apcpPrev ( ) const

inlinenodiscardconstexprnoexcept

Accumulated Precipitation from noon yesterday to start of hourly weather (mm)

Returns

Accumulated Precipitation from noon yesterday to start of hourly weather (mm)

dc()

const Dc & fs::wx::Startup::dc ( ) const

inlinenodiscardconstexprnoexcept

Drought Code.

Returns

Drought Code

distanceFrom()

MathSize fs::wx::Startup::distanceFrom ( ) const

inlinenodiscardconstexprnoexcept

Distance Startup value location is from the requested location (m)

Returns

Distance Startup value location is from the requested location (m)

dmc()

const Dmc & fs::wx::Startup::dmc ( ) const

inlinenodiscardconstexprnoexcept

Duff Moisture Code.

Returns

Duff Moisture Code

ffmc()

const Ffmc & fs::wx::Startup::ffmc ( ) const

inlinenodiscardconstexprnoexcept

Fine Fuel Moisture Code.

Returns

Fine Fuel Moisture Code

generated()

const tm & fs::wx::Startup::generated ( ) const

inlinenodiscardconstexprnoexcept

Time the Startup value is for.

Returns

Time the Startup value is for

isOverridden()

bool fs::wx::Startup::isOverridden ( ) const

inlinenodiscardconstexprnoexcept

Whether or not any Startup values were overridden.

Returns

Whether or not any Startup values were overridden

operator=() [1/2]

Startup & fs::wx::Startup::operator= ( const Startup & rhs )

default

Copy assignment operator.

Parameters

rhs	Startup to copy from

Returns

This, after assignment

operator=() [2/2]

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

defaultnoexcept

Move assignment operator.

Parameters

rhs	Startup to move from

Returns

This, after assignment

point()

const topo::Point & fs::wx::Startup::point ( ) const

inlinenodiscardconstexprnoexcept

Point the Startup value is for.

Returns

Point the Startup value is for

station()

const string & fs::wx::Startup::station ( ) const

inlinenodiscardconstexprnoexcept

Station providing the Startup values.

Returns

Station providing the Startup values

---

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

• firestarr/src/cpp/Startup.h