- Commented file

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@406 3ecf2c5c-341e-0410-92b4-d18e462d057c
This commit is contained in:
elvez 2006-02-23 18:01:00 +00:00
parent 1d326590ee
commit 34fba3517a
1 changed files with 67 additions and 1 deletions

View File

@ -40,15 +40,81 @@ namespace sgpem
class TextSimulation;
/**
\brief Concrete \ref Simulation subclass with a text-based user interface.
A command-based interface is used, so methods of the base class can be called with
a proper command string obtained from the input device(s).
Any object returned after the call to Simulation will be returned to the output
devices(s) in a human-readable format.
*/
class SG_DLLEXPORT TextSimulation : public Simulation, public sigc::trackable
{
public:
~TextSimulation();
/**
\brief Executes a command read from an input device.
A list of supported commands follows:
\li help \<string\> \br
If \<string\> is a valid command, usage instructions are printed
for the command.
\li run \br
Calls run()
\li pause \br
Calls pause()
\li stop \br
Calls stop()
\li setmode \<bool\> \br
Calls set_mode()
\li getmode \br
Calls get_mode()
\li settimer \<int\> \br
Calls set_timer()
\li gettimer \br
Calls get_timer()
\li reset \br
Calls reset()
\li jumpto \<int\> \br
Calls jump_to()
\li setpolicy \<string\> \br
Calls set_policy()
\li getpolicy \br
Calls get_policy(), and prints the name and a description of
the returned policy
\li getpolicies \br
Calls get_avaiable_policies(), and prints a list of policy
descriptions in the same way as getpolicy does
\li setpolicyattributes \<name\> = \<value\>; \<name\> = \<value\>; \br
Changes the value of the policy's attributes
\li getpolicyattributes
Prints the name and the value of the policy's attributes
*/
static void parse_command(std::pair< std::pair<TextSimulation*, IOManager*>, const Glib::ustring >);
/**
Adds an available I/O device.
*/
void add_io_device(memory::smart_ptr<IOManager>);
/**
Prints the actual state of the simulation, with emphasis on the current
status of the scheduling process (ready queue and running process).
*/
void update();
private: