VPTissue Reference Manual
Signals | Public Member Functions | Static Public Member Functions | List of all members
SimPT_Shell::CoupledCliController Class Reference

Command line interface application controller. More...

#include <CoupledCliController.h>

Inheritance diagram for SimPT_Shell::CoupledCliController:
Inheritance graph
Collaboration diagram for SimPT_Shell::CoupledCliController:
Collaboration graph

Signals

void TerminationRequested ()
 Private signal, to be used for signaling that the simulation should stop.
 

Public Member Functions

virtual ~CoupledCliController ()
 Virtual destructor.
 
int Execute (CliSimulationTask task)
 Execute the task defined via prior SetTask call. More...
 
Timings GetTimings () const
 Execution timings in duration units specified in Timeable base class. More...
 
void Terminate ()
 Request termination of the simulation.
 
- Public Member Functions inherited from SimPT_Sim::ClockMan::Timeable<>
virtual ~Timeable ()
 Destructor virtual for polymorphic class.
 

Static Public Member Functions

static std::shared_ptr< CoupledCliController > Create (const std::string &workspace, bool quiet)
 Create controller. More...
 

Additional Inherited Members

- 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.
 

Detailed Description

Command line interface application controller.

Definition at line 45 of file CoupledCliController.h.

Member Function Documentation

std::shared_ptr< CoupledCliController > SimPT_Shell::CoupledCliController::Create ( const std::string &  workspace,
bool  quiet 
)
static

Create controller.

Parameters
workspacework space that it operates in
quietmode (verbosity)
Exceptions
Exceptionin case of work space problems

Definition at line 84 of file CoupledCliController.cpp.

References SimPT_Sim::Util::Exception::what().

Here is the call graph for this function:

int SimPT_Shell::CoupledCliController::Execute ( CliSimulationTask  task)

Execute the task defined via prior SetTask call.

Returns
status indicates whether task ran OK.

Definition at line 115 of file CoupledCliController.cpp.

References SimPT_Sim::ClockMan::Stopwatch< T >::Get(), and SimPT_Sim::ClockMan::Stopwatch< T >::GetName().

Here is the call graph for this function:

CoupledCliController::Timings SimPT_Shell::CoupledCliController::GetTimings ( ) const
virtual

Execution timings in duration units specified in Timeable base class.

Returns
records with timing info

Implements SimPT_Sim::ClockMan::Timeable<>.

Definition at line 135 of file CoupledCliController.cpp.

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