Steereo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== SteereoSimSteering =====

==== Description ====
The name says it all. This class provides the central functions to enable steering in your simulation. An example how it is used can be seen in the [[steereo:simple_howto#enable_basic_steering_capabilities_in_the_simulation|Howto]]. It manages also the connections to the clients as well as the command queue(s).

==== Important Functions ====

=== Functions you will need ===
If these functions aren't used in your simulation, then steering is not enabled.
  * <code cpp> void setCommunicator (SteereoCommunicator* newComm) </code> Sets the communicator for your //SimSteering// instance. It will be used for accepting connections and data transfer to and from clients.
  * <code cpp> void startListening () </code> With this the simulation will start listening and thus accepting connections from clients (in an own thread so your simulations shouldn't be disturbed that much). You should have set a [[steereocommunicator|SteereoCommunicator]] before calling this function.
  *  <code cpp> void processQueue(int queueNumber = 0) </code> Process the requests that are stored in the queue //queueNumber// (usually you will have only one queue and the default value 0 is ok). You should probably put this into the simulation loop, so that the requests can be processed not to long after receiving them.

=== Functions that you may need ===
If you need some more functionality you can't ignore these functions.
  * <code cpp> void registerCommand (PtrToGenerator ptr, std::string commandName) </code> With this you register your own commands under the name //commandName// with which this command can be requested from the clients. //PtrToGenerator// is the pointer to the //generateNewInstance// function of your command (e.g. &MyCommand::generateNewInstance).
  * <code cpp> void registerSignalHandler (PtrToGenerator ptr, int sig) </code> Register your own command for the signal number //sig//. With this your command gets executed, when the simulation gets a signal (from the operating system or an user).
  * <code cpp> void setNumberOfQueues (int nr) </code> Set the number of queues in your simulation.
Steereo Wiki

User Tools

Site Tools

Page Tools
