Antares Simulator
Power System Simulator
suffix-for-cluster-names.hxx
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_HXX__
22 #define __ANTARES_LIBS_STUDY_ACTION_SETTINGS_SUFFIX_CLUSTER_NAME_HXX__
23 
24 namespace Antares::Action::Settings
25 {
26 template<class StringT>
27 inline SuffixPlantName::SuffixPlantName(const StringT& value, bool enabled):
28  pValue(value)
29 {
30  pInfos.caption = "Suffix for thermal cluster names";
31 
32  if (!enabled)
33  {
34  pInfos.behavior = bhSkip;
35  }
36 }
37 
39 {
40 }
41 
43 {
44  return true;
45 }
46 
47 inline bool SuffixPlantName::autoExpand() const
48 {
49  return false;
50 }
51 
52 inline bool SuffixPlantName::shouldPrepareRootNode() const
53 {
54  return true;
55 }
56 
57 } // namespace Antares::Action::Settings
58 
59 #endif // __ANTARES_LIBS_STUDY_ACTION_SETTINGS_SUFFIX_CLUSTER_NAME_HXX__
Behavior behavior
Behavior of the action.
Definition: fwd.h:56
Yuni::String caption
Caption.
Definition: fwd.h:60
Definition: context.h:36
ActionInformations pInfos
All data related to the action.
Definition: action.h:170
virtual bool autoExpand() const
Auto-expand.
Definition: suffix-for-cluster-names.hxx:47
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