Antares Simulator
Power System Simulator
decal-area-position.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_SETTINGS_DECAL_AREA_POSITION_H__
22 #define __ANTARES_LIBS_STUDY_ACTION_SETTINGS_DECAL_AREA_POSITION_H__
23 
24 #include <yuni/yuni.h>
25 #include "../action.h"
26 
27 namespace Antares::Action::Settings
28 {
33 {
34 public:
36  using Ptr = IAction::Ptr;
39 
40 public:
42 
43 
46  explicit DecalAreaPosition(bool enabled = true);
48  virtual ~DecalAreaPosition();
50 
51  virtual bool autoExpand() const;
52 
53  virtual bool shouldPrepareRootNode() const;
54 
55  virtual void behaviorToText(Behavior behavior, Yuni::String& out);
56 
57 protected:
58  virtual bool prepareWL(Context& ctx);
59  virtual bool performWL(Context& ctx);
60  virtual void prepareSkipWL(Context& ctx);
61 
62 private:
63  Yuni::String pValueX;
64  Yuni::String pValueY;
65 
66 }; // class DecalAreaPosition
67 
68 } // namespace Antares::Action::Settings
69 
70 #include "decal-area-position.hxx"
71 
72 #endif // __ANTARES_LIBS_STUDY_ACTION_SETTINGS_DECAL_AREA_POSITION_H__
Definition: context.h:36
Definition: action.h:36
AncestorType::Ptr Ptr
The most suitable smart ptr for the class.
Definition: action.h:41
Behavior behavior() const
Get the behavior.
Definition: action.hxx:36
AncestorType::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition: action.h:43
A dummy action, for displaying some text.
Definition: decal-area-position.h:33
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition: decal-area-position.cpp:44
virtual bool autoExpand() const
Auto-expand.
Definition: decal-area-position.hxx:35
virtual ~DecalAreaPosition()
Destructor.
Definition: decal-area-position.hxx:26
virtual void prepareSkipWL(Context &ctx)
Prepare the execution (when the behavior says that the action should be skipped)
Definition: decal-area-position.cpp:37
DecalAreaPosition(bool enabled=true)
Default constructor.
Definition: decal-area-position.cpp:26
virtual bool performWL(Context &ctx)
Perform the action.
Definition: decal-area-position.hxx:30