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

Representation of lineic number, a reciprocal of length, internally stored as floating-point units per meter. More...

#include <lineic_number.h>

Public Member Functions

 LineicNumber ()
 Creates a lineic number object representing an 'unknown' lineic number.
 
float inGigaUnitsPerMeter () const
 Returns the lineic number in GigaUnitsPerMeter.
 
float inMegaUnitsPerMeter () const
 Returns the lineic number in Mega-units per meter.
 
float inKiloUnitsPerMeter () const
 Returns the lineic number in kilo-units per meter.
 
float inUnitsPerMeter () const
 Returns the lineic number in units per meter.
 
float inMilliUnitsPerMeter () const
 Returns the lineic number in milli-units per meter.
 
float inMicroUnitsPerMeter () const
 Returns the lineic number in micro-units per meter.
 
float inUnitsPerCentimeter () const
 Returns the lineic number in units per centimeter.
 
float inUnitsPerMillimeter () const
 Returns the lineic number in units per millimeter.
 
float inUnitsPerKilometer () const
 Returns the lineic number in units per kilometer.
 
float inUnitsPerInch () const
 Returns the lineic number in units per inch (DPI).
 
float inDPI () const
 Returns the lineic number in units per inch (DPI).
 
float inUnitsPerFoot () const
 Returns the lineic number in units per foot.
 
float inUnitsPerYard () const
 Returns the lineic number in units per yard.
 
bool isUnknown () const
 Returns whether the object represents an unknown lineic number.
 
bool operator< (const LineicNumber &other) const
 
bool operator== (const LineicNumber &other) const
 
bool operator> (const LineicNumber &other) const
 
bool operator<= (const LineicNumber &other) const
 
bool operator>= (const LineicNumber &other) const
 
bool operator!= (const LineicNumber &other) const
 
LineicNumber & operator*= (float multi)
 
LineicNumber & operator/= (float div)
 

Friends

LineicNumber UnknownLineicNumber ()
 Returns a lineic number object representing an unknown lineic number.
 
LineicNumber LineicNumberInUnitsPerMeter (float)
 Returns a lineic number object equivalent to the specified lineic number expressed in units per meter.
 

Detailed Description

Representation of lineic number, a reciprocal of length, internally stored as floating-point units per meter.

Definition at line 21 of file lineic_number.h.

Constructor & Destructor Documentation

◆ LineicNumber()

roo_quantity::LineicNumber::LineicNumber ( )
inline

Creates a lineic number object representing an 'unknown' lineic number.

Definition at line 25 of file lineic_number.h.

Member Function Documentation

◆ inDPI()

float roo_quantity::LineicNumber::inDPI ( ) const
inline

Returns the lineic number in units per inch (DPI).

Definition at line 58 of file lineic_number.h.

References inUnitsPerInch().

◆ inGigaUnitsPerMeter()

float roo_quantity::LineicNumber::inGigaUnitsPerMeter ( ) const
inline

Returns the lineic number in GigaUnitsPerMeter.

Definition at line 28 of file lineic_number.h.

◆ inKiloUnitsPerMeter()

float roo_quantity::LineicNumber::inKiloUnitsPerMeter ( ) const
inline

Returns the lineic number in kilo-units per meter.

Definition at line 34 of file lineic_number.h.

◆ inMegaUnitsPerMeter()

float roo_quantity::LineicNumber::inMegaUnitsPerMeter ( ) const
inline

Returns the lineic number in Mega-units per meter.

Definition at line 31 of file lineic_number.h.

◆ inMicroUnitsPerMeter()

float roo_quantity::LineicNumber::inMicroUnitsPerMeter ( ) const
inline

Returns the lineic number in micro-units per meter.

Definition at line 43 of file lineic_number.h.

◆ inMilliUnitsPerMeter()

float roo_quantity::LineicNumber::inMilliUnitsPerMeter ( ) const
inline

Returns the lineic number in milli-units per meter.

Definition at line 40 of file lineic_number.h.

◆ inUnitsPerCentimeter()

float roo_quantity::LineicNumber::inUnitsPerCentimeter ( ) const
inline

Returns the lineic number in units per centimeter.

Definition at line 46 of file lineic_number.h.

◆ inUnitsPerFoot()

float roo_quantity::LineicNumber::inUnitsPerFoot ( ) const
inline

Returns the lineic number in units per foot.

Definition at line 61 of file lineic_number.h.

◆ inUnitsPerInch()

float roo_quantity::LineicNumber::inUnitsPerInch ( ) const
inline

Returns the lineic number in units per inch (DPI).

Definition at line 55 of file lineic_number.h.

Referenced by inDPI().

◆ inUnitsPerKilometer()

float roo_quantity::LineicNumber::inUnitsPerKilometer ( ) const
inline

Returns the lineic number in units per kilometer.

Definition at line 52 of file lineic_number.h.

◆ inUnitsPerMeter()

float roo_quantity::LineicNumber::inUnitsPerMeter ( ) const
inline

Returns the lineic number in units per meter.

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

◆ inUnitsPerMillimeter()

float roo_quantity::LineicNumber::inUnitsPerMillimeter ( ) const
inline

Returns the lineic number in units per millimeter.

Definition at line 49 of file lineic_number.h.

◆ inUnitsPerYard()

float roo_quantity::LineicNumber::inUnitsPerYard ( ) const
inline

Returns the lineic number in units per yard.

Definition at line 64 of file lineic_number.h.

◆ isUnknown()

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

Returns whether the object represents an unknown lineic number.

Definition at line 67 of file lineic_number.h.

◆ operator!=()

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

Definition at line 89 of file lineic_number.h.

◆ operator*=()

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

Definition at line 93 of file lineic_number.h.

◆ operator/=()

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

Definition at line 98 of file lineic_number.h.

◆ operator<()

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

Definition at line 69 of file lineic_number.h.

◆ operator<=()

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

Definition at line 81 of file lineic_number.h.

◆ operator==()

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

Definition at line 73 of file lineic_number.h.

◆ operator>()

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

Definition at line 77 of file lineic_number.h.

◆ operator>=()

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

Definition at line 85 of file lineic_number.h.

Friends And Related Symbol Documentation

◆ LineicNumberInUnitsPerMeter

LineicNumber LineicNumberInUnitsPerMeter ( float  lineic_number)
friend

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

Definition at line 149 of file lineic_number.h.

◆ UnknownLineicNumber

LineicNumber UnknownLineicNumber ( )
friend

Returns a lineic number object representing an unknown lineic number.

Definition at line 127 of file lineic_number.h.

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