XMLFileReader Class Reference

Class to read particle and simulation data from a '.xml' file. More...

#include <XMLFileReader.h>

Inheritance diagram for XMLFileReader:

Collaboration diagram for XMLFileReader:

Public Member Functions
	XMLFileReader (bool fresh, bool allow_recursion=true)
std::tuple< std::vector< Particle >, std::optional< SimulationParams > >	readFile (const std::filesystem::path &filepath) const override
	Reads particle data from a '.xml' file and returns a vector of particles Other simulation parameters are returned as an optional SimulationParams object. More...
Public Member Functions inherited from FileReader
virtual	~FileReader ()=default
	virtual destructor for correct cleanup of derived classes More...

Private Attributes
bool	fresh
bool	allow_recursion

Detailed Description

Class to read particle and simulation data from a '.xml' file.

Definition at line 10 of file XMLFileReader.h.

Constructor & Destructor Documentation

XMLFileReader()

XMLFileReader::XMLFileReader ( bool  fresh, bool  allow_recursion = true  )

inlineexplicit

Definition at line 16 of file XMLFileReader.h.

: fresh(fresh), allow_recursion(allow_recursion) {}

Member Function Documentation

readFile()

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

overridevirtual

Reads particle data from a '.xml' file and returns a vector of particles Other simulation parameters are returned as an optional SimulationParams object.

Parameters

filepath

Path to the file to read

Implements FileReader.

Definition at line 304 of file XMLFileReader.cpp.

                                                                                                                            {
    try {
        auto config = configuration(filepath);
 
        return prepareParticles(filepath, *config, fresh, allow_recursion);
    } catch (const xml_schema::exception& e) {
        std::stringstream error_message;
        error_message << "Error: could not parse file '" << filepath << "'.\n";
        error_message << e << std::endl;
        throw FileFormatException(error_message.str());
    }
}

Member Data Documentation

allow_recursion

bool XMLFileReader::allow_recursion

private

Definition at line 13 of file XMLFileReader.h.

fresh

bool XMLFileReader::fresh

private

Definition at line 12 of file XMLFileReader.h.

---

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

• XMLFileReader.h
• XMLFileReader.cpp