AAO DRAMA/DRAMA2 C++ Interface
DRAMA C++11 and later interface

◆ SetSimulation()

virtual void drama::git::Path::SetSimulation ( const std::string &  value,
const float  timeBase = 1.0,
const std::string &  simArg = "" 
)
virtual

Set simulation and timebase

Set the simulation level and timebase values to be used when the SIMULATE_LEVEL action is sent to the task.

(The SIMULATE_LEVEL action is sent as part of Initialise()).

Parameters
valueThe simulation level, as accepted by the target task, and normally as appropriate for the GIT spec.
timeBaseThe simulation time base. The meaning of this depends on the target target but it often means that any simulation runs this times faster then normal. Many GIT tasks ignore this value.
simArgAn extra string which is stored in the _simArg protected variable. It may or may not be used as an extra argument to the simulation level action, depending on how a sub-class is implemented. The default implementation does not use this value.