Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
Antares::Solver::HebdoProblemToLpsTranslator Class Reference

Class for translating a weekly problem to a linear programming problem. More...

#include <HebdoProblemToLpsTranslator.h>

Public Member Functions

WeeklyDataFromAntares translate (const PROBLEME_ANTARES_A_RESOUDRE *problem, std::string_view name) const
 Translates a weekly problem to a linear programming problem.
 
ConstantDataFromAntares commonProblemData (const PROBLEME_ANTARES_A_RESOUDRE *problem) const
 Retrieves common problem data, the part common to every weekly problems.
 

Detailed Description

Class for translating a weekly problem to a linear programming problem.

This class is responsible for translating a weekly problem to a linear programming problem.

Member Function Documentation

◆ commonProblemData()

ConstantDataFromAntares Antares::Solver::HebdoProblemToLpsTranslator::commonProblemData ( const PROBLEME_ANTARES_A_RESOUDRE * problem) const
nodiscard

Retrieves common problem data, the part common to every weekly problems.

This function takes a pointer to a PROBLEME_ANTARES_A_RESOUDRE object and retrieves the common problem data. It returns a ConstantDataFromAntaresPtr to the common problem data.

Parameters
problemA pointer to the problem from which to retrieve the common data.
Returns
ConstantDataFromAntaresPtr A ConstantDataFromAntaresPtr to the common problem data.

◆ translate()

WeeklyDataFromAntares Antares::Solver::HebdoProblemToLpsTranslator::translate ( const PROBLEME_ANTARES_A_RESOUDRE * problem,
std::string_view name ) const
nodiscard

Translates a weekly problem to a linear programming problem.

This function takes a pointer to a PROBLEME_ANTARES_A_RESOUDRE object and a string_view representing the name of the problem. It translates the weekly problem to a linear programming problem and returns a WeeklyDataFromAntaresPtr to the translated problem. Datas from the PROBLEME_ANTARES_A_RESOUDRE are copied to the WeeklyDataFromAntaresPtr.

Parameters
problemA pointer to the weekly problem to be translated.
nameThe name of the problem.
Returns
WeeklyDataFromAntaresPtr A WeeklyDataFromAntaresPtr to the translated problem.

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