Antares Simulator
Power System Simulator
system.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 <unordered_map>
24 
25 #include "component.h"
26 
27 namespace Antares::ModelerStudy::SystemModel
28 {
29 
33 class System final
34 {
35 public:
36  // Only allowing one private constructor (see below) to forbid empty Systems
37  System() = delete;
38  System(System& other) = delete;
39  System(System&& other) = default;
40 
41  const std::string& Id() const
42  {
43  return id_;
44  }
45 
46  const std::vector<Component>& Components() const
47  {
48  return components_;
49  }
50 
51 private:
52  // Only SystemBuilder is allowed to build System instances
53  friend class SystemBuilder;
54  System(std::string_view id, std::vector<Component>&& components);
55  std::string id_;
56  std::vector<Component> components_;
57 };
58 
59 class SystemBuilder final
60 {
61 public:
62  SystemBuilder& withId(std::string_view id);
63  SystemBuilder& withComponents(std::vector<Component>&& components);
64  System build();
65 
66 private:
67  std::string id_;
68 
69  std::vector<Component> components_;
70 };
71 
72 } // namespace Antares::ModelerStudy::SystemModel
SystemBuilder & withId(std::string_view id)
Sets the ID of the system.
Definition: system.cpp:49
SystemBuilder & withComponents(std::vector< Component > &&components)
Sets the components of the system.
Definition: system.cpp:61
System build()
Builds and returns the System object.
Definition: system.cpp:72