FireSTARR
Loading...
Searching...
No Matches
fs::Startup Class Reference

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

#include <Startup.h>

Collaboration diagram for fs::Startup:

Public Member Functions

constexpr const string_view station () const noexcept
 Station providing the Startup values.
 
constexpr const tm & generated () const noexcept
 Time the Startup value is for.
 
constexpr const 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 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 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
 
 Startup (const Startup &rhs)=default
 
Startup & operator= (Startup &&rhs) noexcept=default
 
Startup & operator= (const Startup &rhs)=default
 

Public Attributes

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)
 

Private Attributes

string station_
 Station indices are from.
 
tm generated_
 When these indices were observed.
 
Point point_
 Point this represents.
 
MathSize distance_from_
 Distance actual point for this is from represented Point (m)
 
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()

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

Constructor.

Parameters
stationStation indices are from
generatedDate/Time indices are from
pointPoint indices were requested for
distance_fromDistance from requested point the weather station is (m)
ffmcFine Fuel Moisture Code
dmcDuff Moisture Code
dcDrought Code
apcp_prevAccumulated Precipitation from noon yesterday to start of hourly weather (mm)
overriddenwhether or not any Startup values were overridden

Member Function Documentation

◆ apcpPrev()

const Precipitation & fs::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)

◆ distanceFrom()

MathSize fs::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)

◆ generated()

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

Time the Startup value is for.

Returns
Time the Startup value is for

◆ isOverridden()

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

Whether or not any Startup values were overridden.

Returns
Whether or not any Startup values were overridden

◆ point()

const Point & fs::Startup::point ( ) const
inlinenodiscardconstexprnoexcept

Point the Startup value is for.

Returns
Point the Startup value is for

◆ station()

const string_view fs::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 files: