Weather::Wind Class Reference

This extremely simple class holds the wind speed and direction. More...

#include <Wind.h>

Public Member Functions
auto	directionFrom () const -> Units::Angle
	Getter function for property of the same name.
auto	speed () const -> Units::Speed
	Getter function for property of the same name.
void	setSpeed (Units::Speed newSpeed)
	Setter function for property of the same name.
void	setDirectionFrom (Units::Angle newDirectionFrom)
	Setter function for property of the same name.
Q_INVOKABLE bool	operator== (Weather::Wind other) const
	Equality check.

Properties
Units::Speed	minWindSpeed
	Minimal wind speed that is considered valid.
Units::Speed	maxWindSpeed
	Maximal wind speed that is considered valid.
Units::Angle	directionFrom
	Wind Direction.
Units::Speed	speed
	Wind Speed.

Detailed Description

This extremely simple class holds the wind speed and direction.

Definition at line 32 of file Wind.h.

Member Function Documentation

directionFrom()

auto Weather::Wind::directionFrom ( ) const -> Units::Angle

inlinenodiscard

Getter function for property of the same name.

Returns

Property windDirection

Definition at line 72 of file Wind.h.

operator==()

Q_INVOKABLE bool Weather::Wind::operator==

(

Weather::Wind

other

)

const

Equality check.

Parameters

other

Wind that is compared to this

Returns

equality

setDirectionFrom()

void Weather::Wind::setDirectionFrom

(

Units::Angle

newDirectionFrom

)

Setter function for property of the same name.

Parameters

newDirectionFrom

Property directionFrom

setSpeed()

void Weather::Wind::setSpeed

(

Units::Speed

newSpeed

)

Setter function for property of the same name.

If newWindSpeed is outside of the interval [minWindSpeed, maxWindSpeed], the property will be set to NaN.

Parameters

newSpeed

Property speed

speed()

auto Weather::Wind::speed ( ) const -> Units::Speed

inlinenodiscard

Getter function for property of the same name.

Returns

Property windSpeed

Definition at line 78 of file Wind.h.

Property Documentation

directionFrom

Units::Angle Weather::Wind::directionFrom

readwrite

Wind Direction.

This property holds the wind direction. This is NaN if no value has been set.

Definition at line 53 of file Wind.h.

speed

Units::Speed Weather::Wind::speed

readwrite

Wind Speed.

This property holds the wind speed. This is a number that lies in the interval [minWindSpeed, maxWindSpeed] or NaN if the wind speed has not been set.

Definition at line 61 of file Wind.h.

---

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

• /home/runner/work/enroute/enroute/src/weather/Wind.h