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

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

#include <include/IMSTypeDefs.h>

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

Public Member Functions

 kHz (double arg)
 Construct a kHz object from a double argument representing kiloHertz. More...
 
kHzoperator= (double arg)
 Assignment of a double argument in kiloHertz to an existing Frequency object. More...
 
 operator double () const
 Return a double representing the Frequency value in kiloHertz. 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...
 

Additional Inherited Members

- 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 kiloHertz.

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

Author
Dave Cowan
Date
2015-11-03
Since
1.0

Constructor & Destructor Documentation

iMS::kHz::kHz ( double  arg)
inline

Construct a kHz object from a double argument representing kiloHertz.

Parameters
[in]argFrequency in kiloHertz
Since
1.0

Member Function Documentation

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

Return a double representing the Frequency value in kiloHertz.

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

prints:

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

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

kHz f;
f = 1.0;
// f contains 1000Hz
Since
1.3

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