Isomet Modular Synthesiser (iMS) API  v1.4.2
iMS API
Public Member Functions | Static Public Member Functions | List of all members
iMS::MHz Class Reference

Type Definition for all operations that require a frequency specification in MegaHertz. More...

#include <include/IMSTypeDefs.h>

Inheritance diagram for iMS::MHz:
Inheritance graph
[legend]
Collaboration diagram for iMS::MHz:
Collaboration graph
[legend]

Public Member Functions

 MHz (double arg)
 Construct a MHz object from a double argument representing MegaHertz. More...
 
MHzoperator= (double arg)
 Assignment of a double argument in MegaHertz to an existing Frequency object. More...
 
 operator double () const
 Return a double representing the Frequency value in MegaHertz. More...
 
- Public Member Functions inherited from iMS::Frequency
 Frequency (double arg=0.0)
 Construct a Frequency object from a double argument representing Hertz. More...
 
Frequencyoperator= (double arg)
 Assignment of a double argument in Hertz to an existing Frequency object. More...
 
 operator double () const
 Return a double representing the Frequency value in Hertz. More...
 

Static Public Member Functions

static unsigned int RenderAsImagePoint (const IMSSystem &, const MHz)
 Used internally by the library to convert a Frequency object into a hardware-dependent integer representation used by the Image for RF Output frequency. More...
 
- Static Public Member Functions inherited from iMS::Frequency
static unsigned int RenderAsPointRate (const IMSSystem &, const Frequency, const bool PrescalerDisable=false)
 Used internally by the library to convert a Frequency object into an hardware-dependent integer representation used by the Image for Internal Oscillator frequency. More...
 

Detailed Description

Type Definition for all operations that require a frequency specification in MegaHertz.

MHz inherits from Frequency, which internally stores the value in Hertz.

Author
Dave Cowan
Date
2015-11-03
Since
1.0

Constructor & Destructor Documentation

iMS::MHz::MHz ( double  arg)
inline

Construct a MHz object from a double argument representing MegaHertz.

Parameters
[in]argFrequency in MegaHertz
Since
1.0

Member Function Documentation

iMS::MHz::operator double ( ) const
inline

Return a double representing the Frequency value in MegaHertz.

Frequency f1(1234567.0);
MHz f2 = f1();
std::cout << "f2's Frequency is: " << f2() << "MHz" << std::endl;

prints:

f2's Frequency is 1.234567MHz
Since
1.0
MHz& iMS::MHz::operator= ( double  arg)
inline

Assignment of a double argument in MegaHertz to an existing Frequency object.

MHz f;
f = 1.0;
// f contains 1,000,000Hz
Since
1.3
static unsigned int iMS::MHz::RenderAsImagePoint ( const IMSSystem ,
const MHz   
)
static

Used internally by the library to convert a Frequency object into a hardware-dependent integer representation used by the Image for RF Output frequency.

Not intended for use in application code


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