FireSTARR
Loading...
Searching...
No Matches
fs::wx::Weather Class Reference

Collection of weather indices used for calculating FwiWeather. More...

#include <Weather.h>

Inheritance diagram for fs::wx::Weather:
Collaboration diagram for fs::wx::Weather:

Public Member Functions

virtual ~Weather ()=default
 Destructor.
 
constexpr Weather () noexcept=default
 Constructor with no initialization.
 
constexpr Weather (const Temperature &temp, const RelativeHumidity &rh, const Wind &wind, const Precipitation &prec) noexcept
 Construct with given indices.
 
constexpr Weather (Weather &&rhs) noexcept=default
 Move constructor.
 
constexpr Weather (const Weather &rhs) noexcept=default
 Copy constructor.
 
Weatheroperator= (Weather &&rhs) noexcept=default
 Move assignment.
 
Weatheroperator= (const Weather &rhs)=default
 Move assignment.
 
constexpr const Temperaturetemp () const noexcept
 Temperature (Celsius)
 
constexpr const RelativeHumidityrh () const noexcept
 Relative Humidity (%)
 
constexpr const Windwind () const noexcept
 Wind (km/h)
 
constexpr const Precipitationprec () const noexcept
 Precipitation (1hr accumulation) (mm)
 

Private Attributes

Temperature temp_
 Temperature (Celsius)
 
RelativeHumidity rh_
 Relative Humidity (%)
 
Wind wind_
 Wind (km/h)
 
Precipitation prec_
 Precipitation (1hr accumulation) (mm)
 

Detailed Description

Collection of weather indices used for calculating FwiWeather.

Constructor & Destructor Documentation

◆ Weather() [1/3]

fs::wx::Weather::Weather ( const Temperature & temp,
const RelativeHumidity & rh,
const Wind & wind,
const Precipitation & prec )
inlineconstexprnoexcept

Construct with given indices.

Parameters
tempTemperature (Celsius)
rhRelative Humidity (%)
windWind (km/h)
precPrecipitation (1hr accumulation) (mm)

◆ Weather() [2/3]

fs::wx::Weather::Weather ( Weather && rhs)
constexprdefaultnoexcept

Move constructor.

Parameters
rhsWeather to move from

◆ Weather() [3/3]

fs::wx::Weather::Weather ( const Weather & rhs)
constexprdefaultnoexcept

Copy constructor.

Parameters
rhsWeather to copy from

Member Function Documentation

◆ operator=() [1/2]

Weather & fs::wx::Weather::operator= ( const Weather & rhs)
default

Move assignment.

Parameters
rhsWeather to copy into this one
Returns
This, after assignment

◆ operator=() [2/2]

Weather & fs::wx::Weather::operator= ( Weather && rhs)
defaultnoexcept

Move assignment.

Parameters
rhsWeather to move into this one
Returns
This, after assignment

◆ prec()

const Precipitation & fs::wx::Weather::prec ( ) const
inlinenodiscardconstexprnoexcept

Precipitation (1hr accumulation) (mm)

Returns
Precipitation (1hr accumulation) (mm)
Here is the caller graph for this function:

◆ rh()

const RelativeHumidity & fs::wx::Weather::rh ( ) const
inlinenodiscardconstexprnoexcept

Relative Humidity (%)

Returns
Relative Humidity (%)
Here is the caller graph for this function:

◆ temp()

const Temperature & fs::wx::Weather::temp ( ) const
inlinenodiscardconstexprnoexcept

Temperature (Celsius)

Returns
Temperature (Celsius)
Here is the caller graph for this function:

◆ wind()

const Wind & fs::wx::Weather::wind ( ) const
inlinenodiscardconstexprnoexcept

Wind (km/h)

Returns
Wind (km/h)
Here is the caller graph for this function:

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