diff options
| author | David Robillard <d@drobilla.net> | 2013-01-20 17:19:00 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2013-01-20 17:19:00 +0000 |
| commit | 017b2304bc15fd8485707a3a9ccd116f97456b4d (patch) | |
| tree | 3edf9869726695705e6a0128f75450e757cf9209 | |
| parent | 69c8cde985cc012b6cae2a49d489553c5be67202 (diff) | |
| download | machina-017b2304bc15fd8485707a3a9ccd116f97456b4d.tar.gz machina-017b2304bc15fd8485707a3a9ccd116f97456b4d.tar.bz2 machina-017b2304bc15fd8485707a3a9ccd116f97456b4d.zip | |
Clean up Machine documentation.
git-svn-id: http://svn.drobilla.net/lad/trunk/machina@5000 a436a847-0d15-0410-975c-d299462d15a1
| -rw-r--r-- | src/engine/Machine.cpp | 7 | ||||
| -rw-r--r-- | src/engine/machina/Machine.hpp | 10 |
2 files changed, 7 insertions, 10 deletions
diff --git a/src/engine/Machine.cpp b/src/engine/Machine.cpp index 155ef86..5858610 100644 --- a/src/engine/Machine.cpp +++ b/src/engine/Machine.cpp @@ -190,8 +190,6 @@ Machine::reset(MIDISink* sink, Raul::TimeStamp time) _is_finished = false; } -/** Return the active Node with the earliest exit time. - */ SPtr<Node> Machine::earliest_node() const { @@ -206,11 +204,6 @@ Machine::earliest_node() const return earliest; } -/** Enter a node at the current _time. - * - * Returns true if node was entered, or false if the maximum active nodes has - * been reached. - */ bool Machine::enter_node(Context& context, SPtr<Node> node, diff --git a/src/engine/machina/Machine.hpp b/src/engine/machina/Machine.hpp index cd94391..d712c33 100644 --- a/src/engine/machina/Machine.hpp +++ b/src/engine/machina/Machine.hpp @@ -65,8 +65,7 @@ public: void write_state(Sord::Model& model); - /** Exit all active nodes and reset time to 0. - */ + /** Exit all active nodes and reset time to 0. */ void reset(MIDISink* sink, Raul::TimeStamp time); /** Run the machine for a (real) time slice. @@ -98,15 +97,20 @@ public: float fitness; // For GA private: - // Audio context + /** Return the active Node with the earliest exit time. */ SPtr<Node> earliest_node() const; void assign(const Machine& other); + /** Enter a node at the current time (called by run()). + * + * @return true if node was entered, otherwise voics are exhausted. + */ bool enter_node(Context& context, SPtr<Node> node, SPtr<Raul::RingBuffer> updates); + /** Exit a node at the current time (called by run()). */ void exit_node(Context& context, SPtr<Node> node, SPtr<Raul::RingBuffer> updates); |