Antares Simulator
Power System Simulator
constraint.h
1 /*
2 ** Copyright 2007-2025, RTE (https://www.rte-france.com)
3 ** See AUTHORS.txt
4 ** SPDX-License-Identifier: MPL-2.0
5 ** This file is part of Antares-Simulator,
6 ** Adequacy and Performance assessment for interconnected energy networks.
7 **
8 ** Antares_Simulator is free software: you can redistribute it and/or modify
9 ** it under the terms of the Mozilla Public Licence 2.0 as published by
10 ** the Mozilla Foundation, either version 2 of the License, or
11 ** (at your option) any later version.
12 **
13 ** Antares_Simulator is distributed in the hope that it will be useful,
14 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ** Mozilla Public Licence 2.0 for more details.
17 **
18 ** You should have received a copy of the Mozilla Public Licence 2.0
19 ** along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
20 */
21 #pragma once
22 
23 #include <string>
24 
25 #include <antares/expressions/expression.h>
26 
27 #include "optimConfig.h"
28 
29 namespace Antares::ModelerStudy::SystemModel
30 {
31 
33 class Constraint final
34 {
35 public:
36  Constraint(std::string id,
37  Expression expression,
38  Modeler::Config::Location location = Modeler::Config::Location::SUBPROBLEMS):
39  id_(std::move(id)),
40  expression_(std::move(expression)),
41  location_(location)
42  {
43  }
44 
45  const std::string& Id() const
46  {
47  return id_;
48  }
49 
50  const Expression& expression() const
51  {
52  return expression_;
53  }
54 
55  [[nodiscard]] Modeler::Config::Location location() const
56  {
57  return location_;
58  }
59 
60 private:
61  std::string id_;
62  Expression expression_;
63  Modeler::Config::Location location_ = Modeler::Config::Location::SUBPROBLEMS;
64 };
65 
66 } // namespace Antares::ModelerStudy::SystemModel
A constraint linking variables and parameters of a model together.
Definition: constraint.h:34