icarus::FlightManifest Class Reference

Generate Flight Manifest (ASCII Data Dictionary). More...

#include <FlightManifest.hpp>

Public Member Functions
	FlightManifest (const Console &console)
void	SetOutputPath (const std::filesystem::path &path)
	Set output file path (default: "signal_dictionary.dict").
void	SetVersion (const std::string &version)
	Set simulation version string.
void	SetConfigSource (const std::string &component, const std::string &source)
	Set config source for a component.
void	SetFullConsoleOutput (bool enabled)
	Enable/disable full console output (default: false, summary only).
void	Generate (const DataDictionary &dict)
	Generate manifest: write full to file, summary to console.
std::string	GenerateFull (const DataDictionary &dict) const
	Generate full manifest string (for file or explicit request).
std::string	GenerateSummary (const DataDictionary &dict) const
	Generate summary string (for console).
void	WriteToFile (const DataDictionary &dict) const
	Write full manifest to file.
void	PrintSummary (const DataDictionary &dict) const
	Print summary to console (default behavior).
void	PrintFull (const DataDictionary &dict) const
	Print full manifest to console (opt-in, use sparingly).

Detailed Description

Generate Flight Manifest (ASCII Data Dictionary).

Called at the end of Provision phase. Behavior:

• Full manifest -> file (signal_dictionary.dict)
• Summary only → console (counts, unwired inputs, warnings)

The full manifest can be thousands of signals, so it's never dumped to console by default.

Constructor & Destructor Documentation

FlightManifest()

icarus::FlightManifest::FlightManifest ( const Console & console )

inlineexplicit

Member Function Documentation

Generate()

void icarus::FlightManifest::Generate ( const DataDictionary & dict )

inline

Generate manifest: write full to file, summary to console.

GenerateFull()

std::string icarus::FlightManifest::GenerateFull ( const DataDictionary & dict ) const

inlinenodiscard

Generate full manifest string (for file or explicit request).

GenerateSummary()

std::string icarus::FlightManifest::GenerateSummary ( const DataDictionary & dict ) const

inlinenodiscard

Generate summary string (for console).

PrintFull()

void icarus::FlightManifest::PrintFull ( const DataDictionary & dict ) const

inline

Print full manifest to console (opt-in, use sparingly).

PrintSummary()

void icarus::FlightManifest::PrintSummary ( const DataDictionary & dict ) const

inline

Print summary to console (default behavior).

SetConfigSource()

void icarus::FlightManifest::SetConfigSource ( const std::string & component, const std::string & source )

inline

Set config source for a component.

SetFullConsoleOutput()

void icarus::FlightManifest::SetFullConsoleOutput ( bool enabled )

inline

Enable/disable full console output (default: false, summary only).

SetOutputPath()

void icarus::FlightManifest::SetOutputPath ( const std::filesystem::path & path )

inline

Set output file path (default: "signal_dictionary.dict").

SetVersion()

void icarus::FlightManifest::SetVersion ( const std::string & version )

inline

Set simulation version string.

WriteToFile()

void icarus::FlightManifest::WriteToFile ( const DataDictionary & dict ) const

inline

Write full manifest to file.

---

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

• include/icarus/io/report/FlightManifest.hpp