SimPT_Shell::CliController Class Reference

Command line interface application controller. More...

#include <CliController.h>

Inheritance diagram for SimPT_Shell::CliController:

Collaboration diagram for SimPT_Shell::CliController:

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

Public Member Functions
virtual	~CliController ()
	Virtual destructor.
int	Execute (CliConverterTask task)
	Execute converter task. More...
int	Execute (CliSimulationTask task)
	Execute simulation task. 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< CliController >	Create (const std::string &workspace, bool quiet)
	Create controller. More...
static std::shared_ptr< CliController >	Create (std::shared_ptr< Ws::CliWorkspace > 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 38 of file CliController.h.

Member Function Documentation

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

static

Create controller.

Parameters

workspace	work space that it operates in
quiet	mode (verbosity)

Definition at line 78 of file CliController.cpp.

Referenced by SimPT_Parex::Simulator::SolveTask().

Here is the caller graph for this function:

static std::shared_ptr<CliController> SimPT_Shell::CliController::Create ( std::shared_ptr< Ws::CliWorkspace >  workspace, bool  quiet  )

static

Create controller.

Parameters

workspace	work space that it operates in
quiet	mode (verbosity)

int SimPT_Shell::CliController::Execute

(

CliConverterTask

task

)

Execute converter task.

Returns

status indicates whether task ran OK.

Definition at line 139 of file CliController.cpp.

References SimPT_Shell::StepSelection::Contains(), SimPT_Sim::ClockMan::Stopwatch< T >::Get(), SimPT_Shell::CliConverterTask::GetInputFormatFilter(), SimPT_Sim::ClockMan::Stopwatch< T >::GetName(), SimPT_Shell::CliConverterTask::GetOutputFormat(), SimPT_Shell::Ws::StartupFileBase::GetPath(), SimPT_Shell::CliConverterTask::GetProjectName(), SimPT_Shell::CliConverterTask::GetTimeStepFilter(), SimPT_Shell::StepSelection::SetSelectionText(), and SimPT_Sim::WallType::ToString().

Here is the call graph for this function:

int SimPT_Shell::CliController::Execute

(

CliSimulationTask

task

)

Execute simulation task.

Returns

status indicates whether task ran OK.

Definition at line 200 of file CliController.cpp.

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

Here is the call graph for this function:

CliController::Timings SimPT_Shell::CliController::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 217 of file CliController.cpp.

---

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

• CliController.h
• CliController.cpp