fs::wx::Dc Class Reference

Drought Code value. More...

#include <FWI.h>

Inheritance diagram for fs::wx::Dc:

Collaboration diagram for fs::wx::Dc:

Public Member Functions
	Dc (const Temperature &temperature, const Precipitation &prec, const Dc &dc_previous, int month, MathSize latitude) noexcept
	Calculate Drought Code.
Public Member Functions inherited from fs::data::Index< T >
	~Index ()=default
	Destructor.
constexpr	Index () noexcept
	Construct with a value of 0.
constexpr	Index (const MathSize value) noexcept
	Construct with given value.
constexpr	Index (Index< T > &&rhs) noexcept=default
	Move constructor.
constexpr	Index (const Index< T > &rhs) noexcept=default
	Copy constructor.
Index< T > &	operator= (Index< T > &&rhs) noexcept=default
	Move assignment.
Index< T > &	operator= (const Index< T > &rhs) noexcept=default
	Copy assignment.
constexpr bool	operator== (const Index< T > &rhs) const noexcept
	Equality operator.
constexpr bool	operator!= (const Index< T > &rhs) const noexcept
	Not equals operator.
constexpr MathSize	asValue () const noexcept
	Returns value as a MathSize.
constexpr bool	operator< (const Index< T > rhs) const noexcept
	Less than operator.
constexpr bool	operator> (const Index< T > rhs) const noexcept
	Greater than operator.
constexpr bool	operator<= (const Index< T > rhs) const noexcept
	Less than or equal to operator.
constexpr bool	operator>= (const Index< T > rhs) const noexcept
	Greater than or equal to operator.
constexpr Index< T >	operator+ (const Index< T > rhs) const noexcept
	Addition operator.
constexpr Index< T >	operator- (const Index< T > rhs) const noexcept
	Subtraction operator.
constexpr Index< T > &	operator+= (const Index< T > rhs) noexcept
	Addition assignment operator.
constexpr Index< T > &	operator-= (const Index< T > rhs) noexcept
	Subtraction assignment operator.

Static Public Attributes
static const Dc	Zero = Dc(0)
	Drought Code of 0.
static const Dc	Invalid = Dc(-1)

Detailed Description

Drought Code value.

Constructor & Destructor Documentation

Dc()

fs::wx::Dc::Dc ( const Temperature & temperature, const Precipitation & prec, const Dc & dc_previous, int month, MathSize latitude )

noexcept

Calculate Drought Code.

Parameters

temperature	Temperature (Celsius)
prec	Precipitation (24hr accumulated, noon-to-noon) (mm)
dc_previous	Drought Code from the previous day
month	Month to calculate for
latitude	Latitude to calculate for

---

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

• firestarr/src/cpp/FWI.h
• firestarr/src/cpp/FWI.cpp