carma::control::Freq Class Reference

Frequency class. More...

#include <carma/control/LOchain.h>

Public Types
enum	UNITS {   uHz, mHz, Hz, KHz,   MHz, GHz }
	Enumeration for units. More...

Public Member Functions
double	div (const Freq &div) const
	Division operation. More...
	Freq ()
	Default constructor. More...
	Freq (double val, UNITS units)
	Constructor, specifying freq and units. More...
double	gigahertz () const
	Accessor, gigaHertz. More...
double	hertz () const
	Accessor, Hertz. More...
double	kilohertz () const
	Accessor, kiloHertz. More...
double	megahertz () const
	Accessor, megaHertz. More...
double	microhertz () const
	Accessor, microHertz. More...
double	millihertz () const
	Accessor, milliHertz. More...
Freq	operator* (const Freq &rhs) const
Freq	operator* (const double &rhs) const
Freq	operator+ (const Freq &rhs) const
Freq	operator- (const Freq &rhs) const
Freq	operator/ (double div) const

Detailed Description

Frequency class.

Developed because there was no default constructor for the services::Frequency class. But also added some handy division methods. And uses enumerations rather than strings for units for additional type safety.

Definition at line 31 of file LOchain.h.

Member Enumeration Documentation

enum carma::control::Freq::UNITS

Enumeration for units.

Definition at line 37 of file LOchain.h.

Constructor & Destructor Documentation

carma::control::Freq::Freq

(

)

Default constructor.

carma::control::Freq::Freq	(	double	val,
		UNITS	units
	)

Constructor, specifying freq and units.

Parameters

val	frequency value
units	units of the frequency

Member Function Documentation

double carma::control::Freq::div

(

const Freq &

div

)

const

Division operation.

One Freq divided by another, returning double.

Parameters

div	divisor frequency

Returns

ratio of the two frequencies

double carma::control::Freq::gigahertz

(

)

const

Accessor, gigaHertz.

double carma::control::Freq::hertz

(

)

const

Accessor, Hertz.

double carma::control::Freq::kilohertz

(

)

const

Accessor, kiloHertz.

double carma::control::Freq::megahertz

(

)

const

Accessor, megaHertz.

double carma::control::Freq::microhertz

(

)

const

Accessor, microHertz.

double carma::control::Freq::millihertz

(

)

const

Accessor, milliHertz.

---

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

• carma/control/LOchain.h