FrameWriterInterceptor Class Reference

#include <FrameWriterInterceptor.h>

Inheritance diagram for FrameWriterInterceptor:

Collaboration diagram for FrameWriterInterceptor:

Public Member Functions
	FrameWriterInterceptor (OutputFormat output_format, int fps, int video_length)
	Construct a new Save File Interceptor object. More...
void	onSimulationStart (Simulation &simulation) override
	This function saves the initial state of the simulation. More...
void	operator() (size_t iteration, Simulation &simulation) override
	This function is called on every nth iteration. It writes the current state of the simulation to a file. More...
void	onSimulationEnd (size_t iteration, Simulation &simulation) override
	This function saves the final state of the simulation. More...
	operator std::string () const override
	The string representation of this interceptor. More...
void	logSummary (int depth) const override
	Logs the summary of the thermostat. More...
Public Member Functions inherited from SimulationInterceptor
virtual	~SimulationInterceptor ()=default
	Destroy the Simulation Interceptor object. More...
void	notify (size_t iteration, Simulation &simulation)
	This function is called by the simulation loop on every iteration. Whenever the iteration is a multiple of every_nth_iteration, the operator() function is called. More...

Private Attributes
size_t	file_counter = 0
std::unique_ptr< FileOutputHandler >	file_output_handler
OutputFormat	output_format
size_t	fps
size_t	video_length

Additional Inherited Members
Protected Attributes inherited from SimulationInterceptor
size_t	every_nth_iteration = 1

Detailed Description

Definition at line 8 of file FrameWriterInterceptor.h.

Constructor & Destructor Documentation

FrameWriterInterceptor()

FrameWriterInterceptor::FrameWriterInterceptor	(	OutputFormat	output_format,
		int	fps,
		int	video_length
	)

Construct a new Save File Interceptor object.

Definition at line 9 of file FrameWriterInterceptor.cpp.

    : output_format(output_format), fps(fps), video_length(video_length) {
    if (fps < 0) {
        Logger::logger->error("FPS must be positive");
        throw std::runtime_error("FPS must be positive");
    }
    if (video_length < 0) {
        Logger::logger->error("Video length must be positive");
        throw std::runtime_error("Video length must be positive");
    }
}

Member Function Documentation

logSummary()

void FrameWriterInterceptor::logSummary ( int  depth ) const

overridevirtual

Logs the summary of the thermostat.

Implements SimulationInterceptor.

Definition at line 44 of file FrameWriterInterceptor.cpp.

                                                       {
    std::string indent = std::string(depth * 2, ' ');
 
    auto supported_output_formats = get_supported_output_formats();
 
    std::string output_format_s =
        std::find_if(supported_output_formats.begin(), supported_output_formats.end(), [this](const auto& format) {
            return format.second == output_format;
        })->first;
 
    Logger::logger->info("{}╟┤{}Frame Writer: {}", indent, ansi_orange_bold, ansi_end);
    Logger::logger->info("{}║   ┌Output format: {}", indent, output_format_s);
    Logger::logger->info("{}║   ├Frames per second: {}", indent, fps);
    Logger::logger->info("{}║   └Video length: {}", indent, video_length);
}

onSimulationEnd()

void FrameWriterInterceptor::onSimulationEnd ( size_t  iteration, Simulation &  simulation  )

overridevirtual

This function saves the final state of the simulation.

Parameters

iteration	The current iteration
simulation	The simulation object

Implements SimulationInterceptor.

Definition at line 39 of file FrameWriterInterceptor.cpp.

                                                                                     {
    file_output_handler->writeFile(static_cast<int>(iteration), simulation.particle_container);
    file_counter++;
}

onSimulationStart()

void FrameWriterInterceptor::onSimulationStart ( Simulation &  simulation )

overridevirtual

This function saves the initial state of the simulation.

Parameters

simulation

The simulation object

Implements SimulationInterceptor.

Definition at line 21 of file FrameWriterInterceptor.cpp.

                                                                     {
    auto expected_iterations = static_cast<size_t>(std::ceil(simulation.params.end_time / simulation.params.delta_t) + 1);
 
    FrameWriterInterceptor::every_nth_iteration = std::max(expected_iterations / (fps * video_length), 1ul);
 
    file_output_handler = std::make_unique<FileOutputHandler>(output_format, simulation.params);
 
    if (simulation.params.start_iteration == 0) {
        file_output_handler->writeFile(simulation.params.start_iteration, simulation.particle_container);
        file_counter++;
    }
}

operator std::string()

FrameWriterInterceptor::operator std::string ( ) const

explicitoverridevirtual

The string representation of this interceptor.

Returns

std::string

This is used to write the final summary of the Interceptors to the console.

Implements SimulationInterceptor.

Definition at line 60 of file FrameWriterInterceptor.cpp.

{ return "Frame Writer: " + std::to_string(file_counter) + " files saved"; }

operator()()

void FrameWriterInterceptor::operator() ( size_t  iteration, Simulation &  simulation  )

overridevirtual

This function is called on every nth iteration. It writes the current state of the simulation to a file.

Parameters

iteration	The current iteration
simulation	The simulation object

Implements SimulationInterceptor.

Definition at line 34 of file FrameWriterInterceptor.cpp.

                                                                                {
    file_output_handler->writeFile(static_cast<int>(iteration), simulation.particle_container);
    file_counter++;
}

Member Data Documentation

file_counter

size_t FrameWriterInterceptor::file_counter = 0

private

Definition at line 54 of file FrameWriterInterceptor.h.

file_output_handler

std::unique_ptr<FileOutputHandler> FrameWriterInterceptor::file_output_handler

private

Definition at line 55 of file FrameWriterInterceptor.h.

fps

size_t FrameWriterInterceptor::fps

private

Definition at line 57 of file FrameWriterInterceptor.h.

output_format

OutputFormat FrameWriterInterceptor::output_format

private

Definition at line 56 of file FrameWriterInterceptor.h.

video_length

size_t FrameWriterInterceptor::video_length

private

Definition at line 58 of file FrameWriterInterceptor.h.

---

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

• FrameWriterInterceptor.h
• FrameWriterInterceptor.cpp