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

The SimulationObserver class is used to observe the simulation. More...

#include <SimulationObserver.h>

Inheritance diagram for Antares::API::SimulationObserver:
Antares::Solver::Simulation::ISimulationObserver

Public Member Functions

void notifyHebdoProblem (const PROBLEME_HEBDO &problemeHebdo, int optimizationNumber, std::string_view name) override
 Used to notify of a solver HEBDO_PROBLEM. HEBDO_PROBLEM is assumed to be properly constructed and valid in order to build LpsFromAntares properly. More...
 
Solver::LpsFromAntares && acquireLps () noexcept
 The acquireLps method is used to take ownership of Antares problems. More...
 

Detailed Description

The SimulationObserver class is used to observe the simulation.

It inherits from the ISimulationObserver interface and overrides the notifyHebdoProblem method.

Member Function Documentation

◆ acquireLps()

Solver::LpsFromAntares && Antares::API::SimulationObserver::acquireLps ( )
noexcept

The acquireLps method is used to take ownership of Antares problems.

Returns
An LpsFromAntares object containing the linear programming problems.

◆ notifyHebdoProblem()

void Antares::API::SimulationObserver::notifyHebdoProblem ( const PROBLEME_HEBDO &  problemeHebdo,
int  optimizationNumber,
std::string_view  name 
)
overridevirtual

Used to notify of a solver HEBDO_PROBLEM. HEBDO_PROBLEM is assumed to be properly constructed and valid in order to build LpsFromAntares properly.

Parameters
problemeHebdoA pointer to a PROBLEME_HEBDO object representing the problem.
optimizationNumberThe number of the optimization.
nameThe name of the problem.

Implements Antares::Solver::Simulation::ISimulationObserver.

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