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

Representation of volumic number, a reciprocal of volume, internally stored as floating-point units per cubic meter. More...

#include <volumic_number.h>

Public Member Functions

 VolumicNumber ()
 Creates an volumic number object representing an 'unknown' volumic number.
 
float inGigaUnitsPerCubicMeter () const
 Returns the volumic number in GigaUnitsPerCubicMeter.
 
float inMegaUnitsPerCubicMeter () const
 Returns the volumic number in Mega-units per cubic meter.
 
float inKiloUnitsPerCubicMeter () const
 Returns the volumic number in kilo-units per cubic meter.
 
float inUnitsPerCubicMeter () const
 Returns the volumic number in units per cubic meter.
 
float inMilliUnitsPerCubicMeter () const
 Returns the volumic number in milli-units per cubic meter.
 
float inMicroUnitsPerCubicMeter () const
 Returns the volumic number in micro-units per cubic meter.
 
float inUnitsPerCubicDecimeter () const
 Returns the volumic number in units per cubic decimeter (liter).
 
float inUnitsPerLiter () const
 Returns the volumic number in units per cubic decimeter (liter).
 
float inUnitsPerCubicCentimeter () const
 Returns the volumic number in units per cubic centimeter.
 
float inUnitsPerCubicMillimeter () const
 Returns the volumic number in units per cubic millimeter.
 
float inUnitsPerCubicKilometer () const
 Returns the volumic number in units per cubic kilometer.
 
float inUnitsPerCubicInch () const
 Returns the volumic number in units per cubic inch.
 
float inUnitsPerCubicFoot () const
 Returns the volumic number in units per cubic foot.
 
float inUnitsPerCubicYard () const
 Returns the volumic number in units per cubic yard.
 
bool isUnknown () const
 Returns whether the object represents an unknown volumic number.
 
bool operator< (const VolumicNumber &other) const
 
bool operator== (const VolumicNumber &other) const
 
bool operator> (const VolumicNumber &other) const
 
bool operator<= (const VolumicNumber &other) const
 
bool operator>= (const VolumicNumber &other) const
 
bool operator!= (const VolumicNumber &other) const
 
VolumicNumber & operator*= (float multi)
 
VolumicNumber & operator/= (float div)
 

Friends

VolumicNumber UnknownVolumicNumber ()
 Returns a volumic number object representing an unknown volumic number.
 
VolumicNumber VolumicNumberInUnitsPerCubicMeter (float)
 Returns a volumic number object equivalent to the specified volumic number expressed in units per cubic meter.
 

Detailed Description

Representation of volumic number, a reciprocal of volume, internally stored as floating-point units per cubic meter.

Definition at line 22 of file volumic_number.h.

Constructor & Destructor Documentation

◆ VolumicNumber()

roo_quantity::VolumicNumber::VolumicNumber ( )
inline

Creates an volumic number object representing an 'unknown' volumic number.

Definition at line 26 of file volumic_number.h.

Member Function Documentation

◆ inGigaUnitsPerCubicMeter()

float roo_quantity::VolumicNumber::inGigaUnitsPerCubicMeter ( ) const
inline

Returns the volumic number in GigaUnitsPerCubicMeter.

Definition at line 29 of file volumic_number.h.

◆ inKiloUnitsPerCubicMeter()

float roo_quantity::VolumicNumber::inKiloUnitsPerCubicMeter ( ) const
inline

Returns the volumic number in kilo-units per cubic meter.

Definition at line 37 of file volumic_number.h.

◆ inMegaUnitsPerCubicMeter()

float roo_quantity::VolumicNumber::inMegaUnitsPerCubicMeter ( ) const
inline

Returns the volumic number in Mega-units per cubic meter.

Definition at line 34 of file volumic_number.h.

◆ inMicroUnitsPerCubicMeter()

float roo_quantity::VolumicNumber::inMicroUnitsPerCubicMeter ( ) const
inline

Returns the volumic number in micro-units per cubic meter.

Definition at line 46 of file volumic_number.h.

◆ inMilliUnitsPerCubicMeter()

float roo_quantity::VolumicNumber::inMilliUnitsPerCubicMeter ( ) const
inline

Returns the volumic number in milli-units per cubic meter.

Definition at line 43 of file volumic_number.h.

◆ inUnitsPerCubicCentimeter()

float roo_quantity::VolumicNumber::inUnitsPerCubicCentimeter ( ) const
inline

Returns the volumic number in units per cubic centimeter.

Definition at line 57 of file volumic_number.h.

◆ inUnitsPerCubicDecimeter()

float roo_quantity::VolumicNumber::inUnitsPerCubicDecimeter ( ) const
inline

Returns the volumic number in units per cubic decimeter (liter).

Definition at line 51 of file volumic_number.h.

Referenced by inUnitsPerLiter().

◆ inUnitsPerCubicFoot()

float roo_quantity::VolumicNumber::inUnitsPerCubicFoot ( ) const
inline

Returns the volumic number in units per cubic foot.

Definition at line 75 of file volumic_number.h.

◆ inUnitsPerCubicInch()

float roo_quantity::VolumicNumber::inUnitsPerCubicInch ( ) const
inline

Returns the volumic number in units per cubic inch.

Definition at line 72 of file volumic_number.h.

◆ inUnitsPerCubicKilometer()

float roo_quantity::VolumicNumber::inUnitsPerCubicKilometer ( ) const
inline

Returns the volumic number in units per cubic kilometer.

Definition at line 67 of file volumic_number.h.

◆ inUnitsPerCubicMeter()

float roo_quantity::VolumicNumber::inUnitsPerCubicMeter ( ) const
inline

Returns the volumic number in units per cubic meter.

Definition at line 40 of file volumic_number.h.

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

◆ inUnitsPerCubicMillimeter()

float roo_quantity::VolumicNumber::inUnitsPerCubicMillimeter ( ) const
inline

Returns the volumic number in units per cubic millimeter.

Definition at line 62 of file volumic_number.h.

◆ inUnitsPerCubicYard()

float roo_quantity::VolumicNumber::inUnitsPerCubicYard ( ) const
inline

Returns the volumic number in units per cubic yard.

Definition at line 78 of file volumic_number.h.

◆ inUnitsPerLiter()

float roo_quantity::VolumicNumber::inUnitsPerLiter ( ) const
inline

Returns the volumic number in units per cubic decimeter (liter).

Definition at line 54 of file volumic_number.h.

References inUnitsPerCubicDecimeter().

◆ isUnknown()

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

Returns whether the object represents an unknown volumic number.

Definition at line 81 of file volumic_number.h.

◆ operator!=()

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

Definition at line 103 of file volumic_number.h.

◆ operator*=()

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

Definition at line 107 of file volumic_number.h.

◆ operator/=()

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

Definition at line 112 of file volumic_number.h.

◆ operator<()

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

Definition at line 83 of file volumic_number.h.

◆ operator<=()

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

Definition at line 95 of file volumic_number.h.

◆ operator==()

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

Definition at line 87 of file volumic_number.h.

◆ operator>()

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

Definition at line 91 of file volumic_number.h.

◆ operator>=()

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

Definition at line 99 of file volumic_number.h.

Friends And Related Symbol Documentation

◆ UnknownVolumicNumber

VolumicNumber UnknownVolumicNumber ( )
friend

Returns a volumic number object representing an unknown volumic number.

Definition at line 142 of file volumic_number.h.

◆ VolumicNumberInUnitsPerCubicMeter

VolumicNumber VolumicNumberInUnitsPerCubicMeter ( float  volumic_number)
friend

Returns a volumic number object equivalent to the specified volumic number expressed in units per cubic meter.

Definition at line 167 of file volumic_number.h.

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