Antares Simulator
Power System Simulator
Public Member Functions | List of all members
Antares::API::APIInternal Class Reference

The APIInternal class is used to run simulations. More...

#include <API.h>

Public Member Functions

SimulationResults run (const IStudyLoader &study_loader, const std::filesystem::path &output, const Antares::Solver::Optimization::OptimizationOptions &optOptions)
 The run method is used to run the simulation. More...
 

Detailed Description

The APIInternal class is used to run simulations.

Member Function Documentation

◆ run()

SimulationResults Antares::API::APIInternal::run ( const IStudyLoader &  study_loader,
const std::filesystem::path &  output,
const Antares::Solver::Optimization::OptimizationOptions &  optOptions 
)

The run method is used to run the simulation.

Parameters
study_loaderA pointer to an IStudyLoader object. The IStudyLoader object is used to load the study that will be simulated.
Returns
SimulationResults object which contains the results of the simulation.
The documentation for this class was generated from the following files: