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

Representation of area, internally stored as floating-point square meters. More...

#include <area.h>

Public Member Functions

 Area ()
 Creates a area object representing an 'unknown' area.
 
float inSquareKilometers () const
 Returns the area in square kilometers.
 
float inHectares () const
 Returns the area in hectares.
 
float inAres () const
 Returns the area in ares.
 
float inSquareMeters () const
 Returns the area in square meters.
 
float inSquareDecimeters () const
 Returns the area in square decimeters.
 
float inSquareCentimeters () const
 Returns the area in square centimeters.
 
float inSquareMillimeters () const
 Returns the area in square millimeters.
 
float inSquareMicrometers () const
 Returns the area in square micrometers.
 
float inAcres () const
 Returns the area in acres.
 
float inSquareInches () const
 Returns the area in square inches.
 
bool isUnknown () const
 Returns whether the object represents an unknown area.
 
bool operator< (const Area &other) const
 
bool operator== (const Area &other) const
 
bool operator> (const Area &other) const
 
bool operator<= (const Area &other) const
 
bool operator>= (const Area &other) const
 
bool operator!= (const Area &other) const
 
Area & operator+= (const Area &other)
 
Area & operator-= (const Area &other)
 
Area & operator*= (float multi)
 
Area & operator/= (float div)
 

Friends

Area UnknownArea ()
 Returns a area object representing an unknown area.
 
Area AreaInSquareMeters (float)
 Returns a area object equivalent to the specified area expressed in square meters.
 

Detailed Description

Representation of area, internally stored as floating-point square meters.

Definition at line 20 of file area.h.

Constructor & Destructor Documentation

◆ Area()

roo_quantity::Area::Area ( )
inline

Creates a area object representing an 'unknown' area.

Definition at line 23 of file area.h.

Member Function Documentation

◆ inAcres()

float roo_quantity::Area::inAcres ( ) const
inline

Returns the area in acres.

Definition at line 50 of file area.h.

◆ inAres()

float roo_quantity::Area::inAres ( ) const
inline

Returns the area in ares.

Definition at line 32 of file area.h.

◆ inHectares()

float roo_quantity::Area::inHectares ( ) const
inline

Returns the area in hectares.

Definition at line 29 of file area.h.

◆ inSquareCentimeters()

float roo_quantity::Area::inSquareCentimeters ( ) const
inline

Returns the area in square centimeters.

Definition at line 41 of file area.h.

◆ inSquareDecimeters()

float roo_quantity::Area::inSquareDecimeters ( ) const
inline

Returns the area in square decimeters.

Definition at line 38 of file area.h.

◆ inSquareInches()

float roo_quantity::Area::inSquareInches ( ) const
inline

Returns the area in square inches.

Definition at line 53 of file area.h.

◆ inSquareKilometers()

float roo_quantity::Area::inSquareKilometers ( ) const
inline

Returns the area in square kilometers.

Definition at line 26 of file area.h.

◆ inSquareMeters()

float roo_quantity::Area::inSquareMeters ( ) const
inline

Returns the area in square meters.

Definition at line 35 of file area.h.

Referenced by roo_quantity::operator*(), roo_quantity::operator*(), 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/(), roo_quantity::operator/(), roo_quantity::operator/(), roo_quantity::operator/(), roo_quantity::operator/(), and roo_quantity::operator/().

◆ inSquareMicrometers()

float roo_quantity::Area::inSquareMicrometers ( ) const
inline

Returns the area in square micrometers.

Definition at line 47 of file area.h.

◆ inSquareMillimeters()

float roo_quantity::Area::inSquareMillimeters ( ) const
inline

Returns the area in square millimeters.

Definition at line 44 of file area.h.

◆ isUnknown()

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

Returns whether the object represents an unknown area.

Definition at line 56 of file area.h.

◆ operator!=()

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

Definition at line 68 of file area.h.

◆ operator*=()

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

Definition at line 80 of file area.h.

◆ operator+=()

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

Definition at line 70 of file area.h.

References inSquareMeters().

◆ operator-=()

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

Definition at line 75 of file area.h.

References inSquareMeters().

◆ operator/=()

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

Definition at line 85 of file area.h.

◆ operator<()

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

Definition at line 58 of file area.h.

◆ operator<=()

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

Definition at line 64 of file area.h.

◆ operator==()

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

Definition at line 60 of file area.h.

◆ operator>()

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

Definition at line 62 of file area.h.

◆ operator>=()

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

Definition at line 66 of file area.h.

Friends And Related Symbol Documentation

◆ AreaInSquareMeters

Area AreaInSquareMeters ( float  area)
friend

Returns a area object equivalent to the specified area expressed in square meters.

Definition at line 133 of file area.h.

◆ UnknownArea

Area UnknownArea ( )
friend

Returns a area object representing an unknown area.

Definition at line 113 of file area.h.

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