Abstract base class for all custom file readers. More...

#include <FileReader.h>

Inheritance diagram for FileReader:

Collaboration diagram for FileReader:

Classes
class	FileFormatException
	Exception to be thrown when the file format is invalid. More...

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

virtual std::tuple< std::vector< Particle >, std::optional< SimulationParams > >	readFile (const std::filesystem::path &filepath) const =0
	Reads the file with the given path and returns a vector of particles. More...

Detailed Description

Abstract base class for all custom file readers.

Definition at line 14 of file FileReader.h.

Constructor & Destructor Documentation

virtual FileReader::~FileReader ( )

virtualdefault

virtual destructor for correct cleanup of derived classes

virtual std::tuple<std::vector<Particle>, std::optional<SimulationParams> > FileReader::readFile ( const std::filesystem::path & filepath ) const

pure virtual

Reads the file with the given path and returns a vector of particles.

Parameters

filepath Path to the file to be read

Implemented in XMLFileReader.

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