roo_quantity
API Documentation for roo_quantity
Loading...
Searching...
No Matches
Public Member Functions | Friends
roo_quantity::VolumeFlowRate Class Reference

Representation of volume flow rate, internally stored as floating-point cubic meters per second. More...

#include <volume_flow_rate.h>

Public Member Functions

 VolumeFlowRate ()
 Creates a volume flow rate object representing an 'unknown' volume flow rate.
 
float inCubicMetersPerSecond () const
 Returns the volume flow rate in cubic meters per second.
 
float inLitersPerSecond () const
 Returns the volume flow rate in liters per second.
 
float inMillilitersPerSecond () const
 Returns the volume flow rate in milliliters per second.
 
bool isUnknown () const
 Returns whether the object represents an unknown volume flow rate.
 
bool operator< (const VolumeFlowRate &other) const
 
bool operator== (const VolumeFlowRate &other) const
 
bool operator> (const VolumeFlowRate &other) const
 
bool operator<= (const VolumeFlowRate &other) const
 
bool operator>= (const VolumeFlowRate &other) const
 
bool operator!= (const VolumeFlowRate &other) const
 
VolumeFlowRate & operator+= (const VolumeFlowRate &other)
 
VolumeFlowRate & operator-= (const VolumeFlowRate &other)
 
VolumeFlowRate & operator*= (float multi)
 
VolumeFlowRate & operator/= (float div)
 

Friends

VolumeFlowRate UnknownVolumeFlowRate ()
 Returns a volume flow rate object representing an unknown volume flow rate.
 
VolumeFlowRate VolumeFlowRateInCubicMetersPerSecond (float)
 Returns a volume flow rate object equivalent to the specified volume flow rate expressed in cubic meters per second.
 

Detailed Description

Representation of volume flow rate, internally stored as floating-point cubic meters per second.

Definition at line 22 of file volume_flow_rate.h.

Constructor & Destructor Documentation

◆ VolumeFlowRate()

roo_quantity::VolumeFlowRate::VolumeFlowRate ( )
inline

Creates a volume flow rate object representing an 'unknown' volume flow rate.

Definition at line 26 of file volume_flow_rate.h.

Member Function Documentation

◆ inCubicMetersPerSecond()

float roo_quantity::VolumeFlowRate::inCubicMetersPerSecond ( ) const
inline

Returns the volume flow rate in cubic meters per second.

Definition at line 29 of file volume_flow_rate.h.

Referenced by roo_quantity::operator*(), roo_quantity::operator*(), roo_quantity::operator*(), roo_quantity::operator*(), roo_quantity::operator+(), operator+=(), roo_quantity::operator-(), roo_quantity::operator-(), operator-=(), roo_quantity::operator/(), and roo_quantity::operator/().

◆ inLitersPerSecond()

float roo_quantity::VolumeFlowRate::inLitersPerSecond ( ) const
inline

Returns the volume flow rate in liters per second.

Definition at line 32 of file volume_flow_rate.h.

◆ inMillilitersPerSecond()

float roo_quantity::VolumeFlowRate::inMillilitersPerSecond ( ) const
inline

Returns the volume flow rate in milliliters per second.

Definition at line 35 of file volume_flow_rate.h.

◆ isUnknown()

bool roo_quantity::VolumeFlowRate::isUnknown ( ) const
inline

Returns whether the object represents an unknown volume flow rate.

Definition at line 40 of file volume_flow_rate.h.

◆ operator!=()

bool roo_quantity::VolumeFlowRate::operator!= ( const VolumeFlowRate &  other) const
inline

Definition at line 62 of file volume_flow_rate.h.

◆ operator*=()

VolumeFlowRate & roo_quantity::VolumeFlowRate::operator*= ( float  multi)
inline

Definition at line 76 of file volume_flow_rate.h.

◆ operator+=()

VolumeFlowRate & roo_quantity::VolumeFlowRate::operator+= ( const VolumeFlowRate &  other)
inline

Definition at line 66 of file volume_flow_rate.h.

References inCubicMetersPerSecond().

◆ operator-=()

VolumeFlowRate & roo_quantity::VolumeFlowRate::operator-= ( const VolumeFlowRate &  other)
inline

Definition at line 71 of file volume_flow_rate.h.

References inCubicMetersPerSecond().

◆ operator/=()

VolumeFlowRate & roo_quantity::VolumeFlowRate::operator/= ( float  div)
inline

Definition at line 81 of file volume_flow_rate.h.

◆ operator<()

bool roo_quantity::VolumeFlowRate::operator< ( const VolumeFlowRate &  other) const
inline

Definition at line 42 of file volume_flow_rate.h.

◆ operator<=()

bool roo_quantity::VolumeFlowRate::operator<= ( const VolumeFlowRate &  other) const
inline

Definition at line 54 of file volume_flow_rate.h.

◆ operator==()

bool roo_quantity::VolumeFlowRate::operator== ( const VolumeFlowRate &  other) const
inline

Definition at line 46 of file volume_flow_rate.h.

◆ operator>()

bool roo_quantity::VolumeFlowRate::operator> ( const VolumeFlowRate &  other) const
inline

Definition at line 50 of file volume_flow_rate.h.

◆ operator>=()

bool roo_quantity::VolumeFlowRate::operator>= ( const VolumeFlowRate &  other) const
inline

Definition at line 58 of file volume_flow_rate.h.

Friends And Related Symbol Documentation

◆ UnknownVolumeFlowRate

VolumeFlowRate UnknownVolumeFlowRate ( )
friend

Returns a volume flow rate object representing an unknown volume flow rate.

Definition at line 111 of file volume_flow_rate.h.

◆ VolumeFlowRateInCubicMetersPerSecond

VolumeFlowRate VolumeFlowRateInCubicMetersPerSecond ( float  volume_flow_rate)
friend

Returns a volume flow rate object equivalent to the specified volume flow rate expressed in cubic meters per second.

Definition at line 115 of file volume_flow_rate.h.

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