SimulatorController: document important restore() side-effect

git-svn-id: https://www4.informatik.uni-erlangen.de/i4svn/danceos/trunk/devel/fail@1104 8c4709b5-6ec9-48aa-a5cd-a96041d1645a
This commit is contained in:
hsc
2012-04-18 14:19:15 +00:00
parent 83e6e1158d
commit 4c9ff80d79

View File

@ -128,7 +128,8 @@ class SimulatorController
*/
virtual void save(const string& path) = 0;
/**
* Restore simulator state.
* Restore simulator state. Implicitly discards all previously
* registered events.
* @param path Location to previously saved state information
*/
virtual void restore(const string& path) = 0;