fs::wx::Isi Class Reference

Initial Spread Index value. More...

#include <FWI.h>

Inheritance diagram for fs::wx::Isi:

Collaboration diagram for fs::wx::Isi:

Public Member Functions
	Isi (MathSize value, const Speed &ws, const Ffmc &ffmc) noexcept
	Calculate Initial Spread Index and verify previous value is within tolerance of calculated value.
	Isi (const Speed &ws, const Ffmc &ffmc) noexcept
	Calculate Initial Spread 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 Isi	Zero = Isi(0)
	Initial Spread Index of 0.
static const Isi	Invalid = Isi(-1)

Detailed Description

Initial Spread Index value.

Constructor & Destructor Documentation

Isi() [1/2]

fs::wx::Isi::Isi ( MathSize value, const Speed & ws, const Ffmc & ffmc )

noexcept

Calculate Initial Spread Index and verify previous value is within tolerance of calculated value.

Parameters

value	Value to check is within tolerance of calculated value
ws	Wind Speed (km/h)
ffmc	Fine Fuel Moisture Code

Here is the call graph for this function:

Isi() [2/2]

fs::wx::Isi::Isi ( const Speed & ws, const Ffmc & ffmc )

noexcept

Calculate Initial Spread Index.

Parameters

ws	Wind Speed (km/h)
ffmc	Fine Fuel Moisture Code

---

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

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