Units::VolumeFlow Class Reference

Convenience class for volume flow computations. More...

#include <VolumeFlow.h>

Public Member Functions
Q_INVOKABLE bool	isFinite () const
	Checks if the volume is valid.
Q_INVOKABLE std::partial_ordering	operator<=> (const Units::VolumeFlow &rhs) const =default
	Comparison.
Q_INVOKABLE double	toLPH () const
	Convert to liters per hour.
Q_INVOKABLE double	toGPH () const
	Convert to gallons per hour.

Static Public Member Functions
static Q_INVOKABLE constexpr Units::VolumeFlow	fromLPH (double volumeFlowInLPH)
	Constructs a volume flow.
static Q_INVOKABLE constexpr Units::VolumeFlow	fromGPH (double volumeFlowInGPH)
	Constructs a volume flow.

Detailed Description

Convenience class for volume flow computations.

This extremely simple class allows computation with volumes flows, without the need to worry about units. On construction, the volume is set to NaN.

Definition at line 35 of file VolumeFlow.h.

Member Function Documentation

fromGPH()

static Q_INVOKABLE constexpr Units::VolumeFlow Units::VolumeFlow::fromGPH ( double volumeFlowInGPH )

inlinestaticconstexpr

Constructs a volume flow.

Parameters

volumeFlowInGPH

volume in gallons per hour

Returns

volume flow

Definition at line 59 of file VolumeFlow.h.

fromLPH()

static Q_INVOKABLE constexpr Units::VolumeFlow Units::VolumeFlow::fromLPH ( double volumeFlowInLPH )

inlinestaticconstexpr

Constructs a volume flow.

Parameters

volumeFlowInLPH

volume flow in liters per hour

Returns

volume flow

Definition at line 46 of file VolumeFlow.h.

isFinite()

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

inlinenodiscard

Checks if the volume is valid.

Returns

True is the volume is a finite number

Definition at line 70 of file VolumeFlow.h.

operator<=>()

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

nodiscarddefault

Comparison.

Parameters

rhs	Right hand side of the comparison

Returns

Result of the comparison

toGPH()

Q_INVOKABLE double Units::VolumeFlow::toGPH ( ) const

inlinenodiscard

Convert to gallons per hour.

Returns

volume flow in gallons per hour

Definition at line 96 of file VolumeFlow.h.

toLPH()

Q_INVOKABLE double Units::VolumeFlow::toLPH ( ) const

inlinenodiscard

Convert to liters per hour.

Returns

volume flow in liters per hour

Definition at line 87 of file VolumeFlow.h.

---

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

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