Icarus
Vehicle Simulation as a Transformable Computational Graph, built on Vulcan and Janus
Loading...
Searching...
No Matches
icarus::MissionDebrief Class Reference

Mission Debrief generator. More...

#include <MissionDebrief.hpp>

Public Member Functions

 MissionDebrief (const Console &console)
void SetExitStatus (ExitStatus status)
 Set exit status.
void SetExitReason (const std::string &reason)
 Set exit reason message.
void SetTiming (double sim_time, double wall_time)
 Set timing information.
void SetProfilingData (const std::vector< ComponentStats > &stats)
 Set profiling data.
std::string Generate () const
 Generate the full debrief string.
void Print () const
 Generate and print to console.

Detailed Description

Mission Debrief generator.

Generates the shutdown statistics and profiling summary.

Constructor & Destructor Documentation

◆ MissionDebrief()

icarus::MissionDebrief::MissionDebrief ( const Console & console)
inlineexplicit

Member Function Documentation

◆ Generate()

std::string icarus::MissionDebrief::Generate ( ) const
inlinenodiscard

Generate the full debrief string.

◆ Print()

void icarus::MissionDebrief::Print ( ) const
inline

Generate and print to console.

◆ SetExitReason()

void icarus::MissionDebrief::SetExitReason ( const std::string & reason)
inline

Set exit reason message.

◆ SetExitStatus()

void icarus::MissionDebrief::SetExitStatus ( ExitStatus status)
inline

Set exit status.

◆ SetProfilingData()

void icarus::MissionDebrief::SetProfilingData ( const std::vector< ComponentStats > & stats)
inline

Set profiling data.

◆ SetTiming()

void icarus::MissionDebrief::SetTiming ( double sim_time,
double wall_time )
inline

Set timing information.


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