FireSTARR
Loading...
Searching...
No Matches
fs::Wind Struct Reference

Wind with a Speed and Direction. More...

#include <Weather.h>

Collaboration diagram for fs::Wind:

Public Member Functions

auto operator<=> (const Wind &rhs) const =default
 
constexpr MathSize heading () const noexcept
 Direction wind is going towards.
 
MathSize wsvX () const noexcept
 X component of wind vector (km/h)
 
MathSize wsvY () const noexcept
 Y component of wind vector (km/h)
 

Static Public Member Functions

static consteval Wind Zero ()
 
static consteval Wind Invalid ()
 

Public Attributes

Speed speed {}
 
Direction direction {}
 

Static Public Attributes

static constexpr auto units {std::tuple{Speed::units, Direction::units}}
 

Detailed Description

Wind with a Speed and Direction.

Member Function Documentation

◆ heading()

MathSize fs::Wind::heading ( ) const
inlinenodiscardconstexprnoexcept

Direction wind is going towards.

Returns
Direction wind is going towards

◆ wsvX()

MathSize fs::Wind::wsvX ( ) const
inlinenodiscardnoexcept

X component of wind vector (km/h)

Returns
X component of wind vector (km/h)

◆ wsvY()

MathSize fs::Wind::wsvY ( ) const
inlinenodiscardnoexcept

Y component of wind vector (km/h)

Returns
Y component of wind vector (km/h)

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