Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
suffix-for-constraint-names.h
1/*
2** Copyright 2007-2024, 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_SUFFIXCONSTRAINT_NAME_H__
22#define __ANTARES_LIBS_STUDY_ACTION_SETTINGS_SUFFIXCONSTRAINT_NAME_H__
23
24#include <yuni/yuni.h>
25#include "../action.h"
26
27namespace Antares
28{
29namespace Action
30{
31namespace Settings
32{
37{
38public:
43
44public:
46
47
50 template<class StringT>
51 explicit SuffixConstraintName(const StringT& value, bool enabled = true);
53 virtual ~SuffixConstraintName();
55
56 virtual bool autoExpand() const;
57
58 virtual bool shouldPrepareRootNode() const;
59
60 virtual void behaviorToText(Behavior behavior, Yuni::String& out);
61
62protected:
63 virtual bool prepareWL(Context& ctx);
64 virtual bool performWL(Context& ctx);
65 virtual void prepareSkipWL(Context& ctx);
66
67private:
68 Yuni::String pValue;
69
70}; // class SuffixConstraintName
71
72} // namespace Settings
73} // namespace Action
74} // namespace Antares
75
76#include "suffix-for-constraint-names.hxx"
77
78#endif // __ANTARES_LIBS_STUDY_ACTION_SETTINGS_SUFFIXCONSTRAINT_NAME_H__
Definition context.h:38
Definition action.h:38
AncestorType::Ptr Ptr
The most suitable smart ptr for the class.
Definition action.h:43
Behavior behavior() const
Get the behavior.
Definition action.hxx:38
AncestorType::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition action.h:45
A dummy action, for displaying some text.
Definition suffix-for-constraint-names.h:37
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition suffix-for-constraint-names.h:40
virtual ~SuffixConstraintName()
Destructor.
Definition suffix-for-constraint-names.hxx:39
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition suffix-for-constraint-names.cpp:36
virtual bool performWL(Context &ctx)
Perform the action.
Definition suffix-for-constraint-names.hxx:43
virtual bool autoExpand() const
Auto-expand.
Definition suffix-for-constraint-names.hxx:48
SuffixConstraintName(const StringT &value, bool enabled=true)
Default constructor.
Definition suffix-for-constraint-names.hxx:31
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition suffix-for-constraint-names.h:42
virtual void prepareSkipWL(Context &ctx)
Prepare the execution (when the behavior says that the action should be skipped)
Definition suffix-for-constraint-names.cpp:30
Command line settings for launching the simulation.
Definition options.h:37