fs::wx::Fwi Class Reference

Fire Weather Index value. More...

#include <FWI.h>

Inheritance diagram for fs::wx::Fwi:

Collaboration diagram for fs::wx::Fwi:

Public Member Functions
	Fwi (MathSize value, const Isi &isi, const Bui &bui) noexcept
	Calculate Fire Weather Index and verify previous value is within tolerance of calculated value.
	Fwi (const Isi &isi, const Bui &bui) noexcept
	Calculate Fire Weather Index.
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 Fwi	Zero = Fwi(0)
	Fire Weather Index of 0.
static const Fwi	Invalid = Fwi(-1)

Detailed Description

Fire Weather Index value.

Constructor & Destructor Documentation

Fwi() [1/2]

fs::wx::Fwi::Fwi ( MathSize value, const Isi & isi, const Bui & bui )

noexcept

Calculate Fire Weather Index and verify previous value is within tolerance of calculated value.

Parameters

value	Value to check is within tolerance of calculated value
isi	Initial Spread Index
bui	Build-up Index

Here is the call graph for this function:

Fwi() [2/2]

fs::wx::Fwi::Fwi ( const Isi & isi, const Bui & bui )

noexcept

Calculate Fire Weather Index.

Parameters

isi	Initial Spread Index
bui	Build-up Index

---

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

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