Thread-safe collector for simulation output metadata. More...

#include "output_metadata.h"

Public Member Functions
	OutputMetadataCollector (std::string output_dir)
	Constructs a metadata collector for the specified output directory.

void	addFile (OutputFileMetadata file_metadata)
	Adds metadata for one generated output file.

OutputMetadata	snapshot () const
	Returns a consistent snapshot of the collected metadata.

Detailed Description

Thread-safe collector for simulation output metadata.

Definition at line 189 of file output_metadata.h.

Constructor & Destructor Documentation

◆ OutputMetadataCollector()

core::OutputMetadataCollector::OutputMetadataCollector ( std::string output_dir )

explicit

Constructs a metadata collector for the specified output directory.

Definition at line 338 of file output_metadata.cpp.

    {
        _metadata.output_directory = std::move(output_dir);
        _metadata.simulation_name = params::params.simulation_name;
        _metadata.start_time = params::startTime();
        _metadata.end_time = params::endTime();
        _metadata.sampling_rate = params::rate();
        _metadata.oversample_ratio = params::oversampleRatio();
    }

References params::endTime(), params::oversampleRatio(), params::params, params::rate(), params::Parameters::simulation_name, and params::startTime().

Here is the call graph for this function:

Member Function Documentation

◆ addFile()

void core::OutputMetadataCollector::addFile ( OutputFileMetadata file_metadata )

Adds metadata for one generated output file.

Definition at line 348 of file output_metadata.cpp.

    {
        std::scoped_lock const lock(_mutex);
        _metadata.files.push_back(std::move(file_metadata));
    }

References max.

◆ snapshot()

OutputMetadata core::OutputMetadataCollector::snapshot ( ) const

Returns a consistent snapshot of the collected metadata.

Definition at line 354 of file output_metadata.cpp.

    {
        std::scoped_lock const lock(_mutex);
        return _metadata;
    }