Antares::FileTreeStudyLoader Class Reference

A class to load studies from the file tree. More...

#include <FileTreeStudyLoader.h>

Inheritance diagram for Antares::FileTreeStudyLoader:

Public Member Functions
	FileTreeStudyLoader (std::filesystem::path study_path)
std::unique_ptr< Antares::Data::Study >	load () const override
	Loads a study from the file tree.
Public Member Functions inherited from Antares::IStudyLoader

Detailed Description

A class to load studies from the file tree.

This class is responsible for loading studies from files in file system.

Note

This class inherits from the IStudyLoader interface.

Member Function Documentation

load()

std::unique_ptr< Antares::Data::Study > Antares::FileTreeStudyLoader::load ( ) const

nodiscardoverridevirtual

Loads a study from the file tree.

This function prepares the arguments required by the Antares Solver application and then calls the application's prepare method. It then returns the study loaded by the application.

Returns

std::shared_ptr<Antares::Data::Study> A shared_ptr to the loaded Study object.

Implements Antares::IStudyLoader.

---

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

• src/libs/antares/file-tree-study-loader/include/antares/file-tree-study-loader/FileTreeStudyLoader.h
• src/libs/antares/file-tree-study-loader/FileTreeStudyLoader.cpp