Antares Simulator
Power System Simulator
suffix-for-cluster-names.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_SUFFIX_CLUSTER_NAME_H__
22 #define __ANTARES_LIBS_STUDY_ACTION_SETTINGS_SUFFIX_CLUSTER_NAME_H__
23 
24 #include <yuni/yuni.h>
25 #include "../action.h"
26 
27 namespace Antares::Action::Settings
28 {
32 class SuffixPlantName: public IAction
33 {
34 public:
36  using Ptr = IAction::Ptr;
39 
40 public:
42 
43 
46  template<class StringT>
47  explicit SuffixPlantName(const StringT& value, bool enabled = true);
49  virtual ~SuffixPlantName();
51 
52  virtual bool autoExpand() const;
53 
54  virtual bool shouldPrepareRootNode() const;
55 
56  virtual void behaviorToText(Behavior behavior, Yuni::String& out);
57 
58 protected:
59  virtual bool prepareWL(Context& ctx);
60  virtual bool performWL(Context& ctx);
61  virtual void prepareSkipWL(Context& ctx);
62 
63 private:
64  Yuni::String pValue;
65 
66 }; // class SuffixPlantName
67 
68 } // namespace Antares::Action::Settings
69 
70 #include "suffix-for-cluster-names.hxx"
71 
72 #endif // __ANTARES_LIBS_STUDY_ACTION_SETTINGS_SUFFIX_CLUSTER_NAME_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: suffix-for-cluster-names.h:33
virtual bool autoExpand() const
Auto-expand.
Definition: suffix-for-cluster-names.hxx:47
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition: suffix-for-cluster-names.cpp:32
virtual ~SuffixPlantName()
Destructor.
Definition: suffix-for-cluster-names.hxx:38
SuffixPlantName(const StringT &value, bool enabled=true)
Default constructor.
Definition: suffix-for-cluster-names.hxx:27
virtual bool performWL(Context &ctx)
Perform the action.
Definition: suffix-for-cluster-names.hxx:42
virtual void prepareSkipWL(Context &ctx)
Prepare the execution (when the behavior says that the action should be skipped)
Definition: suffix-for-cluster-names.cpp:26