FireSTARR
Loading...
Searching...
No Matches
Startup.h
1/* Copyright (c) Queen's Printer for Ontario, 2020. */
2/* Copyright (c) His Majesty the King in Right of Canada as represented by the Minister of Natural Resources, 2025. */
3
4/* SPDX-License-Identifier: AGPL-3.0-or-later */
5
6#pragma once
7#include "stdafx.h"
8#include "FWI.h"
9#include "Point.h"
10#include "Weather.h"
11namespace fs
12{
13namespace wx
14{
19{
20public:
25 [[nodiscard]] constexpr const string& station() const noexcept
26 {
27 return station_;
28 }
33 [[nodiscard]] constexpr const tm& generated() const noexcept
34 {
35 return generated_;
36 }
41 [[nodiscard]] constexpr const topo::Point& point() const noexcept
42 {
43 return point_;
44 }
49 [[nodiscard]] constexpr MathSize distanceFrom() const noexcept
50 {
51 return distance_from_;
52 }
57 [[nodiscard]] constexpr const Ffmc& ffmc() const noexcept
58 {
59 return ffmc_;
60 }
65 [[nodiscard]] constexpr const Dmc& dmc() const noexcept
66 {
67 return dmc_;
68 }
73 [[nodiscard]] constexpr const Dc& dc() const noexcept
74 {
75 return dc_;
76 }
81 [[nodiscard]] constexpr const Precipitation& apcpPrev() const noexcept
82 {
83 return apcp_prev_;
84 }
89 [[nodiscard]] constexpr bool isOverridden() const noexcept
90 {
91 return is_overridden_;
92 }
106 const tm& generated,
107 const topo::Point& point,
108 MathSize distance_from,
109 const Ffmc& ffmc,
110 const Dmc& dmc,
111 const Dc& dc,
112 const Precipitation& apcp_prev,
113 bool overridden) noexcept;
118 Startup(Startup&& rhs) noexcept = default;
123 Startup(const Startup& rhs) = default;
129 Startup& operator=(Startup&& rhs) noexcept = default;
135 Startup& operator=(const Startup& rhs) = default;
139 ~Startup() = default;
140private:
144 string station_;
177};
178}
179}
A geographic location in lat/long coordinates.
Definition Point.h:13
Drought Code value.
Definition FWI.h:73
Duff Moisture Code value.
Definition FWI.h:43
Fine Fuel Moisture Code value.
Definition FWI.h:15
Precipitation (1hr accumulation) (mm)
Definition Weather.h:287
Startup values to initialize a weather stream calculation with.
Definition Startup.h:19
constexpr bool isOverridden() const noexcept
Whether or not any Startup values were overridden.
Definition Startup.h:89
Dmc dmc_
Duff Moisture Code.
Definition Startup.h:164
constexpr const Precipitation & apcpPrev() const noexcept
Accumulated Precipitation from noon yesterday to start of hourly weather (mm)
Definition Startup.h:81
Ffmc ffmc_
Fine Fuel Moisture Code.
Definition Startup.h:160
bool is_overridden_
Whether or not any of the indices have been overridden.
Definition Startup.h:176
Startup & operator=(Startup &&rhs) noexcept=default
Move assignment operator.
Dc dc_
Drought code.
Definition Startup.h:168
string station_
Station indices are from.
Definition Startup.h:144
topo::Point point_
Point this represents.
Definition Startup.h:152
Startup(const Startup &rhs)=default
Copy constructor.
Startup(Startup &&rhs) noexcept=default
Move constructor.
constexpr const Ffmc & ffmc() const noexcept
Fine Fuel Moisture Code.
Definition Startup.h:57
constexpr const string & station() const noexcept
Station providing the Startup values.
Definition Startup.h:25
~Startup()=default
Destructor.
Startup & operator=(const Startup &rhs)=default
Copy assignment operator.
constexpr const Dmc & dmc() const noexcept
Duff Moisture Code.
Definition Startup.h:65
constexpr const Dc & dc() const noexcept
Drought Code.
Definition Startup.h:73
constexpr const tm & generated() const noexcept
Time the Startup value is for.
Definition Startup.h:33
constexpr const topo::Point & point() const noexcept
Point the Startup value is for.
Definition Startup.h:41
constexpr MathSize distanceFrom() const noexcept
Distance Startup value location is from the requested location (m)
Definition Startup.h:49
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.
MathSize distance_from_
Distance actual point for this is from represented Point (m)
Definition Startup.h:156
Precipitation apcp_prev_
Accumulated Precipitation from noon yesterday to start of hourly weather (mm)
Definition Startup.h:172
tm generated_
When these indices were observed.
Definition Startup.h:148