VPTissue Reference Manual
SimPT_Shell::Session::ISimSession Class Referenceabstract

Interface for handling an opened/running simulation. More...

#include <ISimSession.h>

Inheritance diagram for SimPT_Shell::Session::ISimSession:
Inheritance graph
Collaboration diagram for SimPT_Shell::Session::ISimSession:
Collaboration graph

Public Member Functions

virtual std::shared_ptr< SimPT_Sim::SimGetSim ()=0
 Get the simulator.
virtual std::string GetStatusMessage () const =0
 Return status.
- Public Member Functions inherited from SimShell::Session::ISession
virtual ~ISession ()
 Virtual destructor for interface class.
virtual std::shared_ptr< RootViewerTypeCreateRootViewer (Gui::Controller::AppController *parent=nullptr)=0
 Return root viewer, i.e. More...
virtual void ForceExport ()=0
 Force enabled viewers to export. More...
virtual ExportersType GetExporters ()=0
 Return list of callbacks for exporting simulation state to a file.
virtual const boost::property_tree::ptree & GetParameters () const =0
 Get simulation parameters. More...
virtual void SetParameters (const boost::property_tree::ptree &)=0
 Set simulation parameters.
virtual void StartSimulation (int steps=-1)=0
 Starts doing time steps until termination or until stopped. More...
virtual void StopSimulation ()=0
 Stops taking simulation time steps.
virtual void TimeStep ()=0
 Perform 1 simulation step, bringing simulation into the "next" state. More...
- Public Member Functions inherited from SimPT_Sim::ClockMan::Timeable<>
virtual ~Timeable ()
 Destructor virtual for polymorphic class.
virtual Timings GetTimings () const =0
 Timings in duration units specified above.

Additional Inherited Members

- Public Types inherited from SimShell::Session::ISession
using ExportCallbackType = std::function< void(const std::string &)>
using ExportersType = std::vector< std::pair< std::string, ExporterType >>
enum  InfoMessageReason { Stepped, Started, Stopped, Terminated }
 Enumeration for the reason of an emitted InfoMessage from the project.
using RootViewerType = Viewer::IViewerNode
- Public Types inherited from SimPT_Sim::ClockMan::Timeable<>
using Timings = typename ClockTraits< std::chrono::system_clock, typename std::chrono::system_clock::duration >::CumulativeTimings
- Public Types inherited from SimPT_Sim::ClockMan::ClockTraits< std::chrono::system_clock, typename std::chrono::system_clock::duration >
using Clock = std::chrono::system_clock
 Type for clock.
using CumulativeTimings = SimPT_Sim::ClockMan::CumulativeRecords< typename std::chrono::system_clock::duration >
 Records with cumulative timing info.
using Duration = typename std::chrono::system_clock::duration
 Type for time duration units.
using IndividualTimings = SimPT_Sim::ClockMan::IndividualRecords< typename std::chrono::system_clock::duration >
 Records with individual timing info.
using Stopclock = SimPT_Sim::ClockMan::Stopwatch< std::chrono::system_clock >
 Stopwatch to measure time durations.
- Signals inherited from SimShell::Session::ISession
void ErrorMessage (const std::string &error)
 Emitted when an error in a time step occurred (Multithreading cannot return bool directly in ProjectBase::TimeStep(), as the computation is queued for another thread) More...
void InfoMessage (const std::string &message, const InfoMessageReason &reason)
 Emitted when an event with an accompanying info message has been done/occurred (Multithreading cannot return bool directly in ProjectBase::TimeStep(), as the computation is queued for another thread) More...

Detailed Description

Interface for handling an opened/running simulation.

Definition at line 31 of file ISimSession.h.

The documentation for this class was generated from the following file: