Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
system.h
1/*
2** Copyright 2007-2024, 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
27namespace Antares::Study::SystemModel
28{
29
35{
36};
37
41class System
42{
43public:
44 // Only allowing one private constructor (see below) to forbid empty Systems
45 System() = delete;
46 System(System& other) = delete;
47
48 const std::string& Id() const
49 {
50 return id_;
51 }
52
53 const std::unordered_map<std::string, Component>& Components() const
54 {
55 return components_;
56 }
57
58private:
59 // Only SystemBuilder is allowed to build System instances
60 friend class SystemBuilder;
61 System(std::string_view id, std::vector<Component> components);
62 std::string id_;
63 std::unordered_map<std::string, Component> components_;
64 std::pair<std::string, Component> makeComponent(Component& component) const;
65};
66
68{
69public:
70 SystemBuilder& withId(std::string_view id);
71 SystemBuilder& withComponents(std::vector<Component>& components);
72 System build() const;
73
74private:
75 std::string id_;
76 std::vector<Component> components_;
77};
78
79} // namespace Antares::Study::SystemModel
System build() const
Builds and returns the System object.
Definition system.cpp:85
SystemBuilder & withComponents(std::vector< Component > &components)
Sets the components of the system.
Definition system.cpp:74
SystemBuilder & withId(std::string_view id)
Sets the ID of the system.
Definition system.cpp:62