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

Representation of areic number, a reciprocal of area, internally stored as floating-point units per square meter. More...

#include <areic_number.h>

Public Member Functions

 AreicNumber ()
 Creates an areic number object representing an 'unknown' areic number.
 
float inGigaUnitsPerSquareMeter () const
 Returns the areic number in GigaUnitsPerSquareMeter.
 
float inMegaUnitsPerSquareMeter () const
 Returns the areic number in Mega-units per square meter.
 
float inKiloUnitsPerSquareMeter () const
 Returns the areic number in kilo-units per square meter.
 
float inUnitsPerSquareMeter () const
 Returns the areic number in units per square meter.
 
float inMilliUnitsPerSquareMeter () const
 Returns the areic number in milli-units per square meter.
 
float inMicroUnitsPerSquareMeter () const
 Returns the areic number in micro-units per square meter.
 
float inUnitsPerSquareCentimeter () const
 Returns the areic number in units per square centimeter.
 
float inUnitsPerSquareMillimeter () const
 Returns the areic number in units per square millimeter.
 
float inUnitsPerSquareKilometer () const
 Returns the areic number in units per square kilometer.
 
float inUnitsPerSquareInch () const
 Returns the areic number in units per square inch.
 
float inUnitsPerSquareFoot () const
 Returns the areic number in units per square foot.
 
float inUnitsPerSquareYard () const
 Returns the areic number in units per square yard.
 
bool isUnknown () const
 Returns whether the object represents an unknown areic number.
 
bool operator< (const AreicNumber &other) const
 
bool operator== (const AreicNumber &other) const
 
bool operator> (const AreicNumber &other) const
 
bool operator<= (const AreicNumber &other) const
 
bool operator>= (const AreicNumber &other) const
 
bool operator!= (const AreicNumber &other) const
 
AreicNumber & operator*= (float multi)
 
AreicNumber & operator/= (float div)
 

Friends

AreicNumber UnknownAreicNumber ()
 Returns a areic number object representing an unknown areic number.
 
AreicNumber AreicNumberInUnitsPerSquareMeter (float)
 Returns a areic number object equivalent to the specified areic number expressed in units per square meter.
 

Detailed Description

Representation of areic number, a reciprocal of area, internally stored as floating-point units per square meter.

Definition at line 22 of file areic_number.h.

Constructor & Destructor Documentation

◆ AreicNumber()

roo_quantity::AreicNumber::AreicNumber ( )
inline

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

Definition at line 26 of file areic_number.h.

Member Function Documentation

◆ inGigaUnitsPerSquareMeter()

float roo_quantity::AreicNumber::inGigaUnitsPerSquareMeter ( ) const
inline

Returns the areic number in GigaUnitsPerSquareMeter.

Definition at line 29 of file areic_number.h.

◆ inKiloUnitsPerSquareMeter()

float roo_quantity::AreicNumber::inKiloUnitsPerSquareMeter ( ) const
inline

Returns the areic number in kilo-units per square meter.

Definition at line 37 of file areic_number.h.

◆ inMegaUnitsPerSquareMeter()

float roo_quantity::AreicNumber::inMegaUnitsPerSquareMeter ( ) const
inline

Returns the areic number in Mega-units per square meter.

Definition at line 34 of file areic_number.h.

◆ inMicroUnitsPerSquareMeter()

float roo_quantity::AreicNumber::inMicroUnitsPerSquareMeter ( ) const
inline

Returns the areic number in micro-units per square meter.

Definition at line 46 of file areic_number.h.

◆ inMilliUnitsPerSquareMeter()

float roo_quantity::AreicNumber::inMilliUnitsPerSquareMeter ( ) const
inline

Returns the areic number in milli-units per square meter.

Definition at line 43 of file areic_number.h.

◆ inUnitsPerSquareCentimeter()

float roo_quantity::AreicNumber::inUnitsPerSquareCentimeter ( ) const
inline

Returns the areic number in units per square centimeter.

Definition at line 51 of file areic_number.h.

◆ inUnitsPerSquareFoot()

float roo_quantity::AreicNumber::inUnitsPerSquareFoot ( ) const
inline

Returns the areic number in units per square foot.

Definition at line 63 of file areic_number.h.

◆ inUnitsPerSquareInch()

float roo_quantity::AreicNumber::inUnitsPerSquareInch ( ) const
inline

Returns the areic number in units per square inch.

Definition at line 60 of file areic_number.h.

◆ inUnitsPerSquareKilometer()

float roo_quantity::AreicNumber::inUnitsPerSquareKilometer ( ) const
inline

Returns the areic number in units per square kilometer.

Definition at line 57 of file areic_number.h.

◆ inUnitsPerSquareMeter()

float roo_quantity::AreicNumber::inUnitsPerSquareMeter ( ) const
inline

Returns the areic number in units per square meter.

Definition at line 40 of file areic_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/(), roo_quantity::operator/(), and roo_quantity::operator/().

◆ inUnitsPerSquareMillimeter()

float roo_quantity::AreicNumber::inUnitsPerSquareMillimeter ( ) const
inline

Returns the areic number in units per square millimeter.

Definition at line 54 of file areic_number.h.

◆ inUnitsPerSquareYard()

float roo_quantity::AreicNumber::inUnitsPerSquareYard ( ) const
inline

Returns the areic number in units per square yard.

Definition at line 66 of file areic_number.h.

◆ isUnknown()

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

Returns whether the object represents an unknown areic number.

Definition at line 69 of file areic_number.h.

◆ operator!=()

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

Definition at line 91 of file areic_number.h.

◆ operator*=()

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

Definition at line 95 of file areic_number.h.

◆ operator/=()

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

Definition at line 100 of file areic_number.h.

◆ operator<()

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

Definition at line 71 of file areic_number.h.

◆ operator<=()

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

Definition at line 83 of file areic_number.h.

◆ operator==()

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

Definition at line 75 of file areic_number.h.

◆ operator>()

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

Definition at line 79 of file areic_number.h.

◆ operator>=()

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

Definition at line 87 of file areic_number.h.

Friends And Related Symbol Documentation

◆ AreicNumberInUnitsPerSquareMeter

AreicNumber AreicNumberInUnitsPerSquareMeter ( float  areic_number)
friend

Returns a areic number object equivalent to the specified areic number expressed in units per square meter.

Definition at line 151 of file areic_number.h.

◆ UnknownAreicNumber

AreicNumber UnknownAreicNumber ( )
friend

Returns a areic number object representing an unknown areic number.

Definition at line 129 of file areic_number.h.

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