Antares Simulator
Power System Simulator
fwd.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_LIBS_STUDY_ACTION_FWD_H__
22 #define __ANTARES_LIBS_STUDY_ACTION_FWD_H__
23 
24 #include <yuni/yuni.h>
25 #include <yuni/core/string.h>
26 #include <antares/study/study.h>
27 #include <action/behavior.h>
28 #include <action/state.h>
29 
30 namespace Antares::Action
31 {
32 enum LevelOfDetails
33 {
35  lodStandard = 0,
37  lodAdvanced,
38 };
39 
40 class IAction;
41 
43 using PropertyMap = std::map<Yuni::String, Yuni::String>;
44 
46 {
47 public:
49  behavior(bhOverwrite),
50  state(stUnknown)
51  {
52  }
53 
54 public:
56  Behavior behavior;
58  State state;
60  Yuni::String caption;
62  Yuni::String message;
64  PropertyMap property;
65 
66 }; // class ActionInformations
67 
68 } // namespace Antares::Action
69 
70 #endif // __ANTARES_LIBS_STUDY_ACTION_FWD_H__
Yuni::String message
Message.
Definition: fwd.h:62
State state
State of the action.
Definition: fwd.h:58
Behavior behavior
Behavior of the action.
Definition: fwd.h:56
Yuni::String caption
Caption.
Definition: fwd.h:60
PropertyMap property
Properties.
Definition: fwd.h:64