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

Representation of capacitance, internally stored as floating-point Farads. More...

#include <capacitance.h>

Public Member Functions

 Capacitance ()
 Creates a capacitance object representing an 'unknown' capacitance.
 
float inKiloFarads () const
 Returns the capacitance in kiloFarads.
 
float inFarads () const
 Returns the capacitance in Farads.
 
float inMilliFarads () const
 Returns the capacitance in milliFarads.
 
float inMicroFarads () const
 Returns the capacitance in microFarads.
 
float inNanoFarads () const
 Returns the capacitance in nanoFarads.
 
float inPicoFarads () const
 Returns the capacitance in picoFarads.
 
bool isUnknown () const
 Returns whether the object represents an unknown capacitance.
 
bool operator< (const Capacitance &other) const
 
bool operator== (const Capacitance &other) const
 
bool operator> (const Capacitance &other) const
 
bool operator<= (const Capacitance &other) const
 
bool operator>= (const Capacitance &other) const
 
bool operator!= (const Capacitance &other) const
 
Capacitance & operator+= (const Capacitance &other)
 
Capacitance & operator-= (const Capacitance &other)
 
Capacitance & operator*= (float multi)
 
Capacitance & operator/= (float div)
 

Friends

Capacitance UnknownCapacitance ()
 Returns a capacitance object representing an unknown capacitance.
 
Capacitance CapacitanceInFarads (float)
 Returns a capacitance object equivalent to the specified capacitance expressed in Farads.
 

Detailed Description

Representation of capacitance, internally stored as floating-point Farads.

Definition at line 22 of file capacitance.h.

Constructor & Destructor Documentation

◆ Capacitance()

roo_quantity::Capacitance::Capacitance ( )
inline

Creates a capacitance object representing an 'unknown' capacitance.

Definition at line 25 of file capacitance.h.

Member Function Documentation

◆ inFarads()

float roo_quantity::Capacitance::inFarads ( ) const
inline

Returns the capacitance in Farads.

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

◆ inKiloFarads()

float roo_quantity::Capacitance::inKiloFarads ( ) const
inline

Returns the capacitance in kiloFarads.

Definition at line 28 of file capacitance.h.

◆ inMicroFarads()

float roo_quantity::Capacitance::inMicroFarads ( ) const
inline

Returns the capacitance in microFarads.

Definition at line 37 of file capacitance.h.

◆ inMilliFarads()

float roo_quantity::Capacitance::inMilliFarads ( ) const
inline

Returns the capacitance in milliFarads.

Definition at line 34 of file capacitance.h.

◆ inNanoFarads()

float roo_quantity::Capacitance::inNanoFarads ( ) const
inline

Returns the capacitance in nanoFarads.

Definition at line 40 of file capacitance.h.

◆ inPicoFarads()

float roo_quantity::Capacitance::inPicoFarads ( ) const
inline

Returns the capacitance in picoFarads.

Definition at line 43 of file capacitance.h.

◆ isUnknown()

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

Returns whether the object represents an unknown capacitance.

Definition at line 46 of file capacitance.h.

◆ operator!=()

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

Definition at line 68 of file capacitance.h.

◆ operator*=()

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

Definition at line 82 of file capacitance.h.

◆ operator+=()

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

Definition at line 72 of file capacitance.h.

References inFarads().

◆ operator-=()

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

Definition at line 77 of file capacitance.h.

References inFarads().

◆ operator/=()

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

Definition at line 87 of file capacitance.h.

◆ operator<()

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

Definition at line 48 of file capacitance.h.

◆ operator<=()

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

Definition at line 60 of file capacitance.h.

◆ operator==()

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

Definition at line 52 of file capacitance.h.

◆ operator>()

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

Definition at line 56 of file capacitance.h.

◆ operator>=()

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

Definition at line 64 of file capacitance.h.

Friends And Related Symbol Documentation

◆ CapacitanceInFarads

Capacitance CapacitanceInFarads ( float  capacitance)
friend

Returns a capacitance object equivalent to the specified capacitance expressed in Farads.

Definition at line 125 of file capacitance.h.

◆ UnknownCapacitance

Capacitance UnknownCapacitance ( )
friend

Returns a capacitance object representing an unknown capacitance.

Definition at line 115 of file capacitance.h.

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