Antares Simulator
Power System Simulator
build-context.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 #ifndef __ANTARES_TOOLBOX_EXT_SOURCE_HANDLER_BUILD_CONTEXT_H__
22 #define __ANTARES_TOOLBOX_EXT_SOURCE_HANDLER_BUILD_CONTEXT_H__
23 
24 #include <antares/study/study.h>
25 
26 namespace Antares::ExtSource::Handler
27 {
29 {
30 public:
32  using AreaSet = std::set<Data::AreaName>;
33  using LinkSet = std::map<Data::AreaName, std::map<Data::AreaName, bool>>;
34  using ThermalClusterSet = std::map<Data::AreaName, std::map<YString, bool>>;
35  using ConstraintSet = std::set<Yuni::String>;
36 
37 public:
39 
40 
43  BuildContext();
45 
49  bool checkIdentity();
50 
54  bool checkIntegrity(bool forceDialog);
55 
56 public:
58  Data::Area::NameSet area;
59  LinkSet link;
60  ThermalClusterSet cluster;
61  ConstraintSet constraint;
62 
63  std::map<Data::AreaName, Data::AreaName> forceAreaName;
64 
65  bool shouldOverwriteArea;
66 
68  // This flag is required to prevent against invalid copy from another instance
70 
71 }; // class BuildContext
72 
73 } // namespace Antares::ExtSource::Handler
74 
75 #endif // __ANTARES_TOOLBOX_EXT_SOURCE_HANDLER_BUILD_CONTEXT_H__
Definition: build-context.h:29
bool checkIdentity()
Check if the items copied are strictly equivalent to the current user selection.
Definition: build-context.cpp:33
Data::Area::NameSet area
All areas.
Definition: build-context.h:58
bool modifiedWhenCopied
Flag to determine whether the source study was modified when copied.
Definition: build-context.h:69
BuildContext()
Default constructor.
Definition: build-context.cpp:27
std::set< Data::AreaName > AreaSet
Set of area' names.
Definition: build-context.h:32
bool checkIntegrity(bool forceDialog)
Check if the paste can be done.
Definition: build-context.cpp:57