pl-nk v0.4.5
Plonk|Plink|Plank are a set of cross-platform C/C++ frameworks for audio software development
Public Member Functions
SampleRate Class Reference

A specialised Variable<double> for handling sample rates. More...

Inherits Variable< double >.

Inherited by SampleRateDefault, and SampleRateNoPreference.

List of all members.

Public Member Functions

 SampleRate (BlockSize const &blockSize) throw ()
 To catch a potential programming error.
 SampleRate (const double initValue) throw ()
 Create a SampleRate from a double.
 SampleRate (DoubleVariable const &initValue) throw ()
 Create a SampleRate from a DoubleVariable.
 SampleRate (SampleRate const &copy) throw ()
 Copy constructor.

Detailed Description

A specialised Variable<double> for handling sample rates.

One or more SampleRate objects store the sample rate for different parts of the audio graph. There are accessors to get the default sample rate, a zero sample rate (used only by constants), and a "no preference" sample rate (which is equal to -1.0). Generators (e.g., oscillators) should have a preference (e.g., the default sample rate) but processors should commonly specify no preference (thus, their sample rate will be decided according to the sample rate of their inputs).

See also:
BlockSize

Constructor & Destructor Documentation

SampleRate::SampleRate ( BlockSize const &  blockSize) throw ()

To catch a potential programming error.

SampleRate::SampleRate ( const double  initValue) throw ()

Create a SampleRate from a double.

SampleRate::SampleRate ( DoubleVariable const &  initValue) throw ()

Create a SampleRate from a DoubleVariable.

SampleRate::SampleRate ( SampleRate const &  copy) throw ()

Copy constructor.


The documentation for this class was generated from the following files:
 All Classes Functions Typedefs Enumerations Enumerator Properties