comparison CollidoscopeApp/include/EnvASR.h @ 2:dd889fff8423

added some comments
author Fiore Martin <f.martin@qmul.ac.uk>
date Mon, 11 Jul 2016 17:03:40 +0200
parents 02467299402e
children 7fb593d53361
comparison
equal deleted inserted replaced
1:b5bcad8e7803 2:dd889fff8423
1 #pragma once 1 #pragma once
2 2
3 namespace collidoscope { 3 namespace collidoscope {
4 4
5
6 /*
7 * An ASR envelope with linear shape. It is modeled after the STK envelope classes.
8 * The tick() method advances the computation of the envelope one sample and returns the computed sample
9 * The class is templated for the type of the samples that each tick of the envelope produces.
10 *
11 * Client classes can set/get the current state of the envelope with the
12 * respective getter/setter methods
13 *
14 */
5 template <typename T> 15 template <typename T>
6 class EnvASR 16 class EnvASR
7 { 17 {
8 public: 18 public:
9 19