Units::Timespan Class Reference

Convenience class for time computations. More...

#include <Timespan.h>

Public Member Functions
Q_INVOKABLE bool	isFinite () const
	Checks if the time is valid.
Q_INVOKABLE bool	isNegative () const
	Checks if the time is negative.
Q_INVOKABLE Units::Timespan &	operator+= (Units::Timespan other)
	Add time to this time.
Q_INVOKABLE std::partial_ordering	operator<=> (const Units::Timespan &rhs) const =default
	Comparison.
Q_INVOKABLE double	toS () const
	Convert time to seconds.
Q_INVOKABLE double	toM () const
	Convert time to minutes.
Q_INVOKABLE double	toH () const
	Convert time to hours.
Q_INVOKABLE QString	toHoursAndMinutes () const
	Convert time to string.

Static Public Member Functions
static auto	fromH (double timeInH) -> Timespan
	Constructs a time.
static Timespan	fromMS (double timeInMS)
	Constructs a time.
static auto	fromS (double timeInS) -> Timespan
	Constructs a time.

Detailed Description

Convenience class for time computations.

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

Definition at line 35 of file Timespan.h.

Member Function Documentation

fromH()

auto Units::Timespan::fromH ( double timeInH ) -> Timespan

inlinestatic

Constructs a time.

Parameters

timeInH

time in hours

Returns

time

Definition at line 46 of file Timespan.h.

fromMS()

Timespan Units::Timespan::fromMS ( double timeInMS )

inlinestatic

Constructs a time.

Parameters

timeInMS

time in milliseconds

Returns

time

Definition at line 58 of file Timespan.h.

fromS()

auto Units::Timespan::fromS ( double timeInS ) -> Timespan

inlinestatic

Constructs a time.

Parameters

timeInS

time in seconds

Returns

time

Definition at line 71 of file Timespan.h.

isFinite()

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

inlinenodiscard

Checks if the time is valid.

Returns

True is the time is a finite number

Definition at line 81 of file Timespan.h.

isNegative()

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

inlinenodiscard

Checks if the time is negative.

Returns

True is the time is negative

Definition at line 90 of file Timespan.h.

operator+=()

Q_INVOKABLE Units::Timespan & Units::Timespan::operator+= ( Units::Timespan other )

inline

Add time to this time.

Parameters

other

time to be added

Returns

reference to this time

Definition at line 101 of file Timespan.h.

operator<=>()

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

nodiscarddefault

Comparison.

Parameters

rhs	Right hand side of the comparison

Returns

Result of the comparison

toH()

Q_INVOKABLE double Units::Timespan::toH ( ) const

inlinenodiscard

Convert time to hours.

Returns

time in hours

Definition at line 137 of file Timespan.h.

toHoursAndMinutes()

Q_INVOKABLE QString Units::Timespan::toHoursAndMinutes ( ) const

nodiscard

Convert time to string.

Returns

time in hours and minutes, as a string of the form 7:12 or -0:05

toM()

Q_INVOKABLE double Units::Timespan::toM ( ) const

inlinenodiscard

Convert time to minutes.

Returns

time in minutes

Definition at line 128 of file Timespan.h.

toS()

Q_INVOKABLE double Units::Timespan::toS ( ) const

inlinenodiscard

Convert time to seconds.

Returns

time in seconds

Definition at line 119 of file Timespan.h.

---

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

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