Antares Simulator
Power System Simulator
comments.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_HANDLER_ANTARES_CONSTRAINT_COMMENTS_H__
22 #define __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_CONSTRAINT_COMMENTS_H__
23 
24 #include <yuni/yuni.h>
25 #include <action/action.h>
26 
27 namespace Antares::Action::AntaresStudy::Constraint
28 {
29 class Comments: public IAction
30 {
31 public:
33  using Ptr = IAction::Ptr;
36 
37 public:
39 
40 
43  template<class StringT>
44  Comments(const StringT& name);
45 
47  virtual ~Comments();
49 
50 protected:
51  virtual bool prepareWL(Context& ctx);
52  virtual bool performWL(Context& ctx);
53 
54 private:
56  Antares::Data::ConstraintName pOriginalConstraintName;
57 
58 }; // class IAction
59 
60 } // namespace Antares::Action::AntaresStudy::Constraint
61 
62 #include "comments.hxx"
63 
64 #endif // __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_CONSTRAINT_COMMENTS_H__
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition: comments.h:35
virtual ~Comments()
Destructor.
Definition: comments.hxx:33
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition: comments.cpp:27
Comments(const StringT &name)
Default constructor.
Definition: comments.hxx:27
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition: comments.h:33
virtual bool performWL(Context &ctx)
Perform the action.
Definition: comments.cpp:44
Definition: context.h:36
Definition: action.h:36
AncestorType::Ptr Ptr
The most suitable smart ptr for the class.
Definition: action.h:41
AncestorType::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition: action.h:43