engine::SimulationResult Struct Reference

Collaboration diagram for engine::SimulationResult:

Public Member Functions
std::filesystem::path	get_output_filepath (const std::filesystem::path &filename) const
void	set_output_dir ()

Public Attributes
cloe::Stack	config
std::string	uuid
SimulationSync	sync
cloe::Duration	elapsed
SimulationOutcome	outcome
std::vector< std::string >	errors
SimulationStatistics	statistics
cloe::Json	triggers
cloe::Json	report
cloe::Json	signals
std::vector< std::string >	signals_autocompletion
std::optional< std::filesystem::path >	output_dir

Friends
void	to_json (cloe::Json &j, const SimulationResult &r)

Member Function Documentation

get_output_filepath()

std::filesystem::path engine::SimulationResult::get_output_filepath ( const std::filesystem::path &  filename ) const

inline

The output directory of files is normally built up with:

$registry / $id / $filename

If any of the last variables is absolute, the preceding variables shall be ignored; e.g. if $filename is absolute, then neither the simulation registry nor the UUID-based path shall be considered.

If not explicitly specified in the configuration file, the registry and output path are set automatically. Thus, if they are empty, then that is because the user explicitly set them so.

Here is the caller graph for this function:

set_output_dir()

void engine::SimulationResult::set_output_dir ( )

inline

Determine the output directory from config.

Must be called before output_dir is used.

Here is the caller graph for this function:

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/cloe/checkouts/develop/engine/src/simulation.hpp