icarus::DataDictionary Struct Reference

Complete catalog of simulation interface. More...

#include <DataDictionary.hpp>

Classes
struct	ComponentEntry
	Entry for a single component. More...

Public Member Functions
void	AppendComponentsToYAML (YAML::Emitter &out) const
nlohmann::json	ToJSONValue () const
void	ComputeStats ()
	Compute summary statistics from components.
void	ToYAML (const std::string &path) const
	Export to YAML file.
void	ToJSON (const std::string &path) const
	Export to JSON file.

Static Public Member Functions
static void	AppendSignalsToYAML (YAML::Emitter &out, const std::string &key, const std::vector< SignalDescriptor > &signals)

Public Attributes
std::vector< ComponentEntry >	components
	All registered components.
std::size_t	total_outputs = 0
std::size_t	total_inputs = 0
std::size_t	total_parameters = 0
std::size_t	total_config = 0
std::size_t	integrable_states = 0
std::size_t	unwired_inputs = 0

Detailed Description

Complete catalog of simulation interface.

The DataDictionary provides a complete snapshot of the simulation's interface, including all registered outputs, inputs, parameters, and config.

Member Function Documentation

AppendComponentsToYAML()

void icarus::DataDictionary::AppendComponentsToYAML ( YAML::Emitter & out ) const

inline

AppendSignalsToYAML()

void icarus::DataDictionary::AppendSignalsToYAML ( YAML::Emitter & out, const std::string & key, const std::vector< SignalDescriptor > & signals )

inlinestatic

ComputeStats()

void icarus::DataDictionary::ComputeStats ( )

inline

Compute summary statistics from components.

ToJSON()

void icarus::DataDictionary::ToJSON ( const std::string & path ) const

inline

Export to JSON file.

Parameters

path	Output file path

ToJSONValue()

nlohmann::json icarus::DataDictionary::ToJSONValue ( ) const

inlinenodiscard

ToYAML()

void icarus::DataDictionary::ToYAML ( const std::string & path ) const

inline

Export to YAML file.

Parameters

path	Output file path

Member Data Documentation

components

std::vector<ComponentEntry> icarus::DataDictionary::components

All registered components.

integrable_states

std::size_t icarus::DataDictionary::integrable_states = 0

total_config

std::size_t icarus::DataDictionary::total_config = 0

total_inputs

std::size_t icarus::DataDictionary::total_inputs = 0

total_outputs

std::size_t icarus::DataDictionary::total_outputs = 0

total_parameters

std::size_t icarus::DataDictionary::total_parameters = 0

unwired_inputs

std::size_t icarus::DataDictionary::unwired_inputs = 0

---

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

• include/icarus/io/data/DataDictionary.hpp