roo_quantity::Frequency Class Reference

Representation of frequency, internally stored as floating-point Hertz. More...

#include <frequency.h>

Public Member Functions
	Frequency ()
	Creates a frequency object representing an 'unknown' frequency.
float	inGigaHertz () const
	Returns the frequency in GigaHertz.
float	inMegaHertz () const
	Returns the frequency in MegaHertz.
float	inKiloHertz () const
	Returns the frequency in kiloHertz.
float	inHertz () const
	Returns the frequency in Hertz.
float	inMilliHertz () const
	Returns the frequency in milliHertz.
float	inMicroHertz () const
	Returns the frequency in microHertz.
float	inRadiansPerSecond () const
	Returns the rotational frequency in radians per second.
float	inCyclesPerSecond () const
	Returns the rotational frequency in cycles per second (equivalent to Hertz).
float	inRevolutionsPerMinute () const
	Returns the rotational frequency in RPM.
float	inRPM () const
	Returns the rotational frequency in RPM.
bool	isUnknown () const
	Returns whether the object represents an unknown frequency.
bool	operator< (const Frequency &other) const
bool	operator== (const Frequency &other) const
bool	operator> (const Frequency &other) const
bool	operator<= (const Frequency &other) const
bool	operator>= (const Frequency &other) const
bool	operator!= (const Frequency &other) const
Frequency &	operator*= (float multi)
Frequency &	operator/= (float div)

Friends
Frequency	UnknownFrequency ()
	Returns a frequency object representing an unknown frequency.
Frequency	FrequencyInHertz (float)
	Returns a frequency object equivalent to the specified frequency expressed in Hertz.

Detailed Description

Representation of frequency, internally stored as floating-point Hertz.

Definition at line 20 of file frequency.h.

Constructor & Destructor Documentation

Frequency()

roo_quantity::Frequency::Frequency ( )

inline

Creates a frequency object representing an 'unknown' frequency.

Definition at line 23 of file frequency.h.

Member Function Documentation

inCyclesPerSecond()

float roo_quantity::Frequency::inCyclesPerSecond ( ) const

inline

Returns the rotational frequency in cycles per second (equivalent to Hertz).

Definition at line 48 of file frequency.h.

References inHertz().

inGigaHertz()

float roo_quantity::Frequency::inGigaHertz ( ) const

inline

Returns the frequency in GigaHertz.

Definition at line 26 of file frequency.h.

inHertz()

float roo_quantity::Frequency::inHertz ( ) const

inline

Returns the frequency in Hertz.

Definition at line 35 of file frequency.h.

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

inKiloHertz()

float roo_quantity::Frequency::inKiloHertz ( ) const

inline

Returns the frequency in kiloHertz.

Definition at line 32 of file frequency.h.

inMegaHertz()

float roo_quantity::Frequency::inMegaHertz ( ) const

inline

Returns the frequency in MegaHertz.

Definition at line 29 of file frequency.h.

inMicroHertz()

float roo_quantity::Frequency::inMicroHertz ( ) const

inline

Returns the frequency in microHertz.

Definition at line 41 of file frequency.h.

inMilliHertz()

float roo_quantity::Frequency::inMilliHertz ( ) const

inline

Returns the frequency in milliHertz.

Definition at line 38 of file frequency.h.

inRadiansPerSecond()

float roo_quantity::Frequency::inRadiansPerSecond ( ) const

inline

Returns the rotational frequency in radians per second.

Definition at line 44 of file frequency.h.

inRevolutionsPerMinute()

float roo_quantity::Frequency::inRevolutionsPerMinute ( ) const

inline

Returns the rotational frequency in RPM.

Definition at line 51 of file frequency.h.

Referenced by inRPM().

inRPM()

float roo_quantity::Frequency::inRPM ( ) const

inline

Returns the rotational frequency in RPM.

Definition at line 54 of file frequency.h.

References inRevolutionsPerMinute().

isUnknown()

bool roo_quantity::Frequency::isUnknown ( ) const

inline

Returns whether the object represents an unknown frequency.

Definition at line 57 of file frequency.h.

operator!=()

bool roo_quantity::Frequency::operator!= ( const Frequency &  other ) const

inline

Definition at line 79 of file frequency.h.

operator*=()

Frequency & roo_quantity::Frequency::operator*= ( float  multi )

inline

Definition at line 83 of file frequency.h.

operator/=()

Frequency & roo_quantity::Frequency::operator/= ( float  div )

inline

Definition at line 88 of file frequency.h.

operator<()

bool roo_quantity::Frequency::operator< ( const Frequency &  other ) const

inline

Definition at line 59 of file frequency.h.

operator<=()

bool roo_quantity::Frequency::operator<= ( const Frequency &  other ) const

inline

Definition at line 71 of file frequency.h.

operator==()

bool roo_quantity::Frequency::operator== ( const Frequency &  other ) const

inline

Definition at line 63 of file frequency.h.

operator>()

bool roo_quantity::Frequency::operator> ( const Frequency &  other ) const

inline

Definition at line 67 of file frequency.h.

operator>=()

bool roo_quantity::Frequency::operator>= ( const Frequency &  other ) const

inline

Definition at line 75 of file frequency.h.

Friends And Related Symbol Documentation

FrequencyInHertz

Frequency FrequencyInHertz ( float  frequency )

friend

Returns a frequency object equivalent to the specified frequency expressed in Hertz.

Definition at line 138 of file frequency.h.

UnknownFrequency

Frequency UnknownFrequency ( )

friend

Returns a frequency object representing an unknown frequency.

Definition at line 116 of file frequency.h.

---

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

• temp_repos/roo_quantity/src/roo_quantity/frequency.h