$darkmode
engine::Simulation Class Reference

Public Member Functions

 Simulation (const cloe::Stack &config, const std::string &uuid)
 
cloe::Logger logger () const
 
SimulationResult run ()
 
size_t write_output (const SimulationResult &) const
 
bool write_output_file (const boost::filesystem::path &filepath, const cloe::Json &j) const
 
bool is_writable (const boost::filesystem::path &filepath) const
 
void set_report_progress (bool value)
 
void signal_abort ()
 

Member Function Documentation

◆ is_writable()

bool engine::Simulation::is_writable ( const boost::filesystem::path &  filepath) const

Check if the given filepath may be opened, respecting clobber options.

Here is the caller graph for this function:

◆ logger()

cloe::Logger engine::Simulation::logger ( ) const
inline

Return simulation logger.

Here is the caller graph for this function:

◆ run()

SimulationResult engine::Simulation::run ( )

Run a simulation to completion.

Requires the entire engine to be configured first. This will throw an exception on failure.

Here is the call graph for this function:

◆ set_report_progress()

void engine::Simulation::set_report_progress ( bool  value)
inline

Set whether simulation progress should be reported.

◆ signal_abort()

void engine::Simulation::signal_abort ( )

Abort the simulation from a separate thread.

This is used exclusively for handling signals.

◆ write_output()

size_t engine::Simulation::write_output ( const SimulationResult r) const

Write simulation output into files and return number of files written.

Here is the call graph for this function:

◆ write_output_file()

bool engine::Simulation::write_output_file ( const boost::filesystem::path &  filepath,
const cloe::Json &  j 
) const

Write the given JSON output into the file. Return true if successful.

Here is the call graph for this function:
Here is the caller graph for this function:

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