openfluid::machine::GhostSimulatorFileIO Class Reference

Detailed Description

Manages I/O of ghost simulators signatures

#include <machine/GhostSimulatorFileIO.hpp>

Public Member Functions
	GhostSimulatorFileIO ()=delete

Static Public Member Functions
static bool	saveToFile (const openfluid::ware::SimulatorSignature &Signature, const std::string &DirPath)
static bool	loadFromFile (const std::string &FilePath, openfluid::ware::SimulatorSignature &Signature)

Constructor & Destructor Documentation

GhostSimulatorFileIO()

openfluid::machine::GhostSimulatorFileIO::GhostSimulatorFileIO ( )

delete

Member Function Documentation

loadFromFile()

static bool openfluid::machine::GhostSimulatorFileIO::loadFromFile ( const std::string &  FilePath, openfluid::ware::SimulatorSignature &  Signature  )

static

Loads a signature of a ghost simulator from a file

Parameters

[in]	FilePath	The path to the file to load
[out]	Signature	The signature loaded from file

Returns

true if the signature was successfully loaded, false otherwise

saveToFile()

static bool openfluid::machine::GhostSimulatorFileIO::saveToFile ( const openfluid::ware::SimulatorSignature &  Signature, const std::string &  DirPath  )

static

Saves given signature of a ghost simulator to file

Parameters

[in]	Signature	The signature to save to file
[in]	DirPath	The directory path where the signature is saved as a file. The name of the created file is automatically created using the simulator ID.

Returns

true if the signature was successfully saved, false otherwise

---

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

• machine/GhostSimulatorFileIO.hpp