Singularity-Viewer/SingularityViewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation update.

Browse Source
This commit is contained in:
Aleric Inglewood
2013-08-02 13:04:56 +02:00
parent 52f6c5830c
commit 6f733f6f62
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
indra/aistatemachine/aistatemachine.cpp
View File

@@ -202,7 +202,7 @@ char const* HelloWorld::state_str_impl(state_type run_state) const
// with that state. // with that state.
// multiplex_impl() may never reentrant (cause itself to be called). // multiplex_impl() may never reentrant (cause itself to be called).
// multiplex_impl() should end by callling either one of: // multiplex_impl() should end by callling either one of:
// idle(current_state), yield*(), finish() [or abort()]. // idle(), yield*(), finish() [or abort()].
// Leaving multiplex_impl() without calling any of those might result in an // Leaving multiplex_impl() without calling any of those might result in an
// immediate reentry, which could lead to 100% CPU usage unless the state // immediate reentry, which could lead to 100% CPU usage unless the state
// is changed with set_state(). // is changed with set_state().
@@ -212,7 +212,7 @@ char const* HelloWorld::state_str_impl(state_type run_state) const
// the call back passed to run() will be called. // the call back passed to run() will be called.
// Upon return from the call back, the state machine object might be destructed // Upon return from the call back, the state machine object might be destructed
// (see below). // (see below).
// If idle(current_state) was called, and the state was (still) current_state, // If idle() was called, and the state was (still) current_state,
// then multiplex_impl() will not be called again until the state is // then multiplex_impl() will not be called again until the state is
// advanced, or cont() is called. // advanced, or cont() is called.
// //
@@ -245,10 +245,9 @@ char const* HelloWorld::state_str_impl(state_type run_state) const
// following functions can be called: // following functions can be called:
// //
// - set_state(new_state) --> Force the state to new_state. This voids any previous call to set_state() or idle(). // - set_state(new_state) --> Force the state to new_state. This voids any previous call to set_state() or idle().
// - idle(current_state) --> If the current state is still current_state (if there was no call to advance_state() // - idle() --> If there was no call to advance_state() since the last call to set_state(current_state))
// since the last call to set_state(current_state)) then go idle (do nothing until // then go idle (do nothing until cont() or advance_state() is called). If the current
// cont() or advance_state() is called). If the current state is not current_state, // state is not current_state, then multiplex_impl shall be reentered immediately upon return.
// then multiplex_impl shall be reentered immediately upon return.
// - finish() --> Disables any scheduled runs. // - finish() --> Disables any scheduled runs.
// --> finish_impl --> [optional] kill() // --> finish_impl --> [optional] kill()
// --> call back // --> call back