Units::Speed Class Reference

Convenience class for speed computations. More...

#include <Speed.h>

Public Member Functions
Q_INVOKABLE bool	isFinite () const
	Checks if the speed is valid.
Q_INVOKABLE bool	isNegative () const
	Checks if the speed is negative.
Q_INVOKABLE double	operator/ (Units::Speed rhs) const
	Divides two speeds.
Q_INVOKABLE Units::Speed	operator+ (Units::Speed rhs) const
	Adds two speeds.
Q_INVOKABLE Units::Speed	operator- (Units::Speed rhs) const
	Difference of two speeds.
Q_INVOKABLE std::partial_ordering	operator<=> (const Units::Speed &rhs) const =default
	Comparison.
Q_INVOKABLE double	toFPM () const
	Convert to feet per minute.
Q_INVOKABLE double	toMPS () const
	Convert to meters per second.
Q_INVOKABLE double	toMPH () const
	Convert to meters per second.
Q_INVOKABLE double	toKN () const
	Convert to knots.
Q_INVOKABLE double	toKMH () const
	Convert to km/h.

Static Public Member Functions
static Q_INVOKABLE constexpr Units::Speed	fromFPM (double speedInFPM)
	Constructs a speed.
static Q_INVOKABLE constexpr Units::Speed	fromMPS (double speedInMPS)
	Constructs a speed.
static Q_INVOKABLE constexpr Units::Speed	fromMPH (double speedInMPH)
	Constructs a speed.
static Q_INVOKABLE constexpr Units::Speed	fromKN (double speedInKT)
	Constructs a speed.
static Q_INVOKABLE constexpr Units::Speed	fromKMH (double speedInKMH)
	Constructs a speed.

Static Public Attributes
static constexpr double	FPM_per_MPS = 196.85039370079
	Unitless constant: one feet per minute / meters per second.
static constexpr double	MPS_per_MPH = 0.44704
	Unitless constant: one mile per hour / meters per second.
static constexpr double	KMH_per_MPS = 3.6
	Unitless constant: one km/h / meters per second.
static constexpr double	KN_per_MPS = 1.943844
	Unitless constant: one knot / meters per second.
static constexpr double	KMH_per_KT = KMH_per_MPS / KN_per_MPS
	Unitless constant: one km/h / knot.

Detailed Description

Convenience class for speed computations.

This extremely simple class allows computation with speeds, without the need to worry about units.

Definition at line 36 of file Speed.h.

Member Function Documentation

fromFPM()

static Q_INVOKABLE constexpr Units::Speed Units::Speed::fromFPM ( double speedInFPM )

inlinestaticconstexpr

Constructs a speed.

Parameters

speedInFPM

speed in feet per minute

Returns

speed

Definition at line 47 of file Speed.h.

fromKMH()

static Q_INVOKABLE constexpr Units::Speed Units::Speed::fromKMH ( double speedInKMH )

inlinestaticconstexpr

Constructs a speed.

Parameters

speedInKMH

speed in km/h

Returns

speed

Definition at line 100 of file Speed.h.

fromKN()

static Q_INVOKABLE constexpr Units::Speed Units::Speed::fromKN ( double speedInKT )

inlinestaticconstexpr

Constructs a speed.

Parameters

speedInKT

speed in knots

Returns

speed

Definition at line 87 of file Speed.h.

fromMPH()

static Q_INVOKABLE constexpr Units::Speed Units::Speed::fromMPH ( double speedInMPH )

inlinestaticconstexpr

Constructs a speed.

Parameters

speedInMPH

speed in statute miles per hous

Returns

speed

Definition at line 74 of file Speed.h.

fromMPS()

static Q_INVOKABLE constexpr Units::Speed Units::Speed::fromMPS ( double speedInMPS )

inlinestaticconstexpr

Constructs a speed.

Parameters

speedInMPS

speed in meters per second

Returns

speed

Definition at line 60 of file Speed.h.

isFinite()

Q_INVOKABLE bool Units::Speed::isFinite ( ) const

inlinenodiscard

Checks if the speed is valid.

Returns

True is the speed is a finite number

Definition at line 111 of file Speed.h.

isNegative()

Q_INVOKABLE bool Units::Speed::isNegative ( ) const

inlinenodiscard

Checks if the speed is negative.

Returns

True is the distance is negative

Definition at line 120 of file Speed.h.

operator+()

Q_INVOKABLE Units::Speed Units::Speed::operator+ ( Units::Speed rhs ) const

inline

Adds two speeds.

Parameters

rhs	Right hand side

Returns

Sum

Definition at line 145 of file Speed.h.

operator-()

Q_INVOKABLE Units::Speed Units::Speed::operator- ( Units::Speed rhs ) const

inline

Difference of two speeds.

Parameters

rhs	Right hand side

Returns

Difference

Definition at line 156 of file Speed.h.

operator/()

Q_INVOKABLE double Units::Speed::operator/ ( Units::Speed rhs ) const

inline

Divides two speeds.

Parameters

rhs	Denominator of the division

Returns

Quotient as a dimension-less number

Definition at line 131 of file Speed.h.

operator<=>()

Q_INVOKABLE std::partial_ordering Units::Speed::operator<=> ( const Units::Speed & rhs ) const

nodiscarddefault

Comparison.

Parameters

rhs	Right hand side of the comparison

Returns

Result of the comparison

toFPM()

Q_INVOKABLE double Units::Speed::toFPM ( ) const

inlinenodiscard

Convert to feet per minute.

Returns

Speed in feet per minute

Definition at line 173 of file Speed.h.

toKMH()

Q_INVOKABLE double Units::Speed::toKMH ( ) const

inlinenodiscard

Convert to km/h.

Returns

speed in knots (=Nautical miles per hour)

Definition at line 209 of file Speed.h.

toKN()

Q_INVOKABLE double Units::Speed::toKN ( ) const

inlinenodiscard

Convert to knots.

Returns

speed in knots (=Nautical miles per hour)

Definition at line 200 of file Speed.h.

toMPH()

Q_INVOKABLE double Units::Speed::toMPH ( ) const

inlinenodiscard

Convert to meters per second.

Returns

speed in status miles per hour

Definition at line 191 of file Speed.h.

toMPS()

Q_INVOKABLE double Units::Speed::toMPS ( ) const

inlinenodiscard

Convert to meters per second.

Returns

speed in meters per second

Definition at line 182 of file Speed.h.

---

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

• /home/runner/work/enroute/enroute/src/units/Speed.h