Abstract base class for all file writers. More...

#include <FileWriter.h>

Inheritance diagram for FileWriter:

Collaboration diagram for FileWriter:

Public Member Functions
virtual	~FileWriter ()=default
	virtual destructor for correct cleanup of derived classes More...

virtual const std::filesystem::path	writeFile (const SimulationParams &params, size_t iteration, const std::vector< Particle > &particles) const =0
	Writes the file to the given path, uses the given ParticleContainer and the current iteration. More...

Detailed Description

Abstract base class for all file writers.

Definition at line 12 of file FileWriter.h.

Constructor & Destructor Documentation

virtual FileWriter::~FileWriter ( )

virtualdefault

virtual destructor for correct cleanup of derived classes

virtual const std::filesystem::path FileWriter::writeFile	(	const SimulationParams &	params,
		size_t	iteration,
		const std::vector< Particle > &	particles
	)		const

pure virtual

Writes the file to the given path, uses the given ParticleContainer and the current iteration.

Parameters

params	SimulationParams object which provides the output directory path
iteration	The current iteration number
particles	A vector of particles to write to the file

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