- Fixed a couple of problems in doc

git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@412 3ecf2c5c-341e-0410-92b4-d18e462d057c
This commit is contained in:
elvez 2006-02-23 20:59:56 +00:00
parent 24edbf1c43
commit 876fb85614
4 changed files with 25 additions and 16 deletions

View File

@ -42,6 +42,7 @@ namespace sgpem
/** /**
\brief Called by observed subject. \brief Called by observed subject.
This will be called by the observed subject once something of This will be called by the observed subject once something of
interest to this observer happens. interest to this observer happens.
\see ObservedSubject \see ObservedSubject

View File

@ -68,6 +68,7 @@ namespace sgpem
/** /**
\brief Runs the simulation. \brief Runs the simulation.
Advances the simulation by one or more steps, depending on the Advances the simulation by one or more steps, depending on the
actual state and on the value set with set_mode(). actual state and on the value set with set_mode().
*/ */
@ -75,6 +76,7 @@ namespace sgpem
/** /**
\brief Pauses a running simulation. \brief Pauses a running simulation.
It is obviously useful only when the advancement mode is continue. It is obviously useful only when the advancement mode is continue.
Calling again run() will cause the simulation to start from the current Calling again run() will cause the simulation to start from the current
simulation step. simulation step.
@ -83,6 +85,7 @@ namespace sgpem
/** /**
\brief Stops the simulation. \brief Stops the simulation.
Behaves in the same way as pause(), except that the next call to run() Behaves in the same way as pause(), except that the next call to run()
will cause the simulation to start from the beginning. will cause the simulation to start from the beginning.
*/ */
@ -90,6 +93,7 @@ namespace sgpem
/** /**
\brief Reset the simulation. \brief Reset the simulation.
Erases the state of the simulation, and takes care of removing any Erases the state of the simulation, and takes care of removing any
residual or temporary data to ensure the simulation has reached a residual or temporary data to ensure the simulation has reached a
clean and stable state. clean and stable state.
@ -103,6 +107,7 @@ namespace sgpem
/** /**
\brief Setter for the attribute timer_interval. \brief Setter for the attribute timer_interval.
This method is used to define how a single time unit is to be This method is used to define how a single time unit is to be
interpreted when the simulation advancement mode is continue. interpreted when the simulation advancement mode is continue.
The input value is in milliseconds, and it must be in range [0, 10000]. The input value is in milliseconds, and it must be in range [0, 10000].
@ -116,6 +121,7 @@ namespace sgpem
/** /**
\brief This methods allows to change the way the simulation progresses. \brief This methods allows to change the way the simulation progresses.
If the input value is 0 (false), the simulation will advance a single time If the input value is 0 (false), the simulation will advance a single time
step for each call to run(). step for each call to run().
If the input value is 1 (true), the simulation will advance contiuosly, If the input value is 1 (true), the simulation will advance contiuosly,
@ -132,6 +138,7 @@ namespace sgpem
/** /**
\brief Setup the policy to be used by the system. \brief Setup the policy to be used by the system.
The input pointer must be one of those returned by get_avaiable_policies(). The input pointer must be one of those returned by get_avaiable_policies().
*/ */
void set_policy(Policy*); void set_policy(Policy*);

View File

@ -57,7 +57,7 @@ namespace sgpem {
Glib::ustring read_command(); Glib::ustring read_command();
/** /**
Returns wheter this device can simultaneously read and write. Returns whether this device can simultaneously read and write.
\return true if the device can read and write simultaneously, false otherwise. \return true if the device can read and write simultaneously, false otherwise.
*/ */
bool is_full_duplex(); bool is_full_duplex();

View File

@ -54,54 +54,55 @@ namespace sgpem
/** /**
\brief Executes a command read from an input device. \brief Executes a command read from an input device.
A list of supported commands follows: A list of supported commands follows:
\li help \<string\> \br \li help \<string\> <br>
If \<string\> is a valid command, usage instructions are printed If \<string\> is a valid command, usage instructions are printed
for the command. for the command.
\li run \br \li run <br>
Calls run() Calls run()
\li pause \br \li pause <br>
Calls pause() Calls pause()
\li stop \br \li stop <br>
Calls stop() Calls stop()
\li setmode \<bool\> \br \li setmode \<bool\> <br>
Calls set_mode() Calls set_mode()
\li getmode \br \li getmode <br>
Calls get_mode() Calls get_mode()
\li settimer \<int\> \br \li settimer \<int\> <br>
Calls set_timer() Calls set_timer()
\li gettimer \br \li gettimer <br>
Calls get_timer() Calls get_timer()
\li reset \br \li reset <br>
Calls reset() Calls reset()
\li jumpto \<int\> \br \li jumpto \<int\> <br>
Calls jump_to() Calls jump_to()
\li setpolicy \<string\> \br \li setpolicy \<string\> <br>
Calls set_policy() Calls set_policy()
\li getpolicy \br \li getpolicy <br>
Calls get_policy(), and prints the name and a description of Calls get_policy(), and prints the name and a description of
the returned policy the returned policy
\li getpolicies \br \li getpolicies <br>
Calls get_avaiable_policies(), and prints a list of policy Calls get_avaiable_policies(), and prints a list of policy
descriptions in the same way as getpolicy does descriptions in the same way as getpolicy does
\li setpolicyattributes \<name\> = \<value\>; \<name\> = \<value\>; \br \li setpolicyattributes \<name\> = \<value\>; \<name\> = \<value\>; <br>
Changes the value of the policy's attributes Changes the value of the policy's attributes
\li getpolicyattributes \li getpolicyattributes <br>
Prints the name and the value of the policy's attributes Prints the name and the value of the policy's attributes
*/ */
static void parse_command(std::pair< std::pair<TextSimulation*, IOManager*>, const Glib::ustring >); static void parse_command(std::pair< std::pair<TextSimulation*, IOManager*>, const Glib::ustring >);