fs::wx::Wind Class Reference

Wind with a Speed and Direction. More...

#include <Weather.h>

Collaboration diagram for fs::wx::Wind:

Public Member Functions
	~Wind ()=default
	Destructor.
constexpr	Wind () noexcept
	Construct with 0 values.
	Wind (const Direction &direction, const Speed speed) noexcept
	Constructor.
constexpr	Wind (const Wind &rhs) noexcept=default
	Copy constructor.
constexpr	Wind (Wind &&rhs) noexcept=default
	Move constructor.
Wind &	operator= (const Wind &rhs) noexcept=default
	Copy assignment.
Wind &	operator= (Wind &&rhs) noexcept=default
	Move assignment.
constexpr const Speed &	speed () const noexcept
	Speed of wind (km/h)
constexpr const Direction &	direction () const noexcept
	Direction wind is coming from.
constexpr MathSize	heading () const noexcept
	Direction wind is going towards.
constexpr MathSize	wsvX () const noexcept
	X component of wind vector (km/h)
constexpr MathSize	wsvY () const noexcept
	Y component of wind vector (km/h)
constexpr bool	operator!= (const Wind &rhs) const noexcept
	Not equal to operator.
constexpr bool	operator== (const Wind &rhs) const noexcept
	Equals to operator.
constexpr bool	operator< (const Wind &rhs) const noexcept
	Less than operator.

Static Public Attributes
static const Wind	Zero = Wind(Direction::Zero, Speed::Zero)
	Wind with 0 Speed from Direction 0.
static const Wind	Invalid = Wind(Direction::Invalid, Speed::Invalid)

Private Attributes
MathSize	wsv_x_
	Wind speed vector in X direction (East is positive)
MathSize	wsv_y_
	Wind speed vector in Y direction (North is positive)
Direction	direction_
	Direction (degrees or radians, N is 0)
Speed	speed_
	Speed (km/h)

Detailed Description

Wind with a Speed and Direction.

Constructor & Destructor Documentation

Wind() [1/3]

fs::wx::Wind::Wind ( const Direction & direction, const Speed speed )

inlinenoexcept

Constructor.

Parameters

direction	Direction wind is coming from
speed	Speed of wind

Wind() [2/3]

fs::wx::Wind::Wind ( const Wind & rhs )

constexprdefaultnoexcept

Copy constructor.

Parameters

rhs	Wind to copy from

Wind() [3/3]

fs::wx::Wind::Wind ( Wind && rhs )

constexprdefaultnoexcept

Move constructor.

Parameters

rhs	Wind to move from

Member Function Documentation

direction()

const Direction & fs::wx::Wind::direction ( ) const

inlinenodiscardconstexprnoexcept

Direction wind is coming from.

Returns

Direction wind is coming from.

Here is the caller graph for this function:

heading()

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

inlinenodiscardconstexprnoexcept

Direction wind is going towards.

Returns

Direction wind is going towards

Here is the call graph for this function:

Here is the caller graph for this function:

operator!=()

bool fs::wx::Wind::operator!= ( const Wind & rhs ) const

inlinenodiscardconstexprnoexcept

Not equal to operator.

Parameters

rhs	Wind to compare to

Returns

Whether or not these are not equivalent

operator<()

bool fs::wx::Wind::operator< ( const Wind & rhs ) const

inlinenodiscardconstexprnoexcept

Less than operator.

Parameters

rhs	Wind to compare to

Returns

Whether or not this is less than the compared to Wind

operator=() [1/2]

Wind & fs::wx::Wind::operator= ( const Wind & rhs )

defaultnoexcept

Copy assignment.

Parameters

rhs	Wind to copy into this one

Returns

This, after assignment

operator=() [2/2]

Wind & fs::wx::Wind::operator= ( Wind && rhs )

defaultnoexcept

Move assignment.

Parameters

rhs	Wind to move into this one

Returns

This, after assignment

operator==()

bool fs::wx::Wind::operator== ( const Wind & rhs ) const

inlinenodiscardconstexprnoexcept

Equals to operator.

Parameters

rhs	Wind to compare to

Returns

Whether or not these are equivalent

speed()

const Speed & fs::wx::Wind::speed ( ) const

inlinenodiscardconstexprnoexcept

Speed of wind (km/h)

Returns

Speed of wind (km/h)

Here is the caller graph for this function:

wsvX()

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

inlinenodiscardconstexprnoexcept

X component of wind vector (km/h)

Returns

X component of wind vector (km/h)

Here is the caller graph for this function:

wsvY()

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

inlinenodiscardconstexprnoexcept

Y component of wind vector (km/h)

Returns

Y component of wind vector (km/h)

Here is the caller graph for this function:

---

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

• firestarr/src/cpp/Weather.h
• firestarr/src/cpp/Weather.cpp