Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
create.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_HANDLER_ANTARES_CONSTRAINT_CREATE_H__
22#define __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_CONSTRAINT_CREATE_H__
23
24#include <yuni/yuni.h>
25#include <action/action.h>
26
27namespace Antares
28{
29namespace Action
30{
31namespace AntaresStudy
32{
33namespace Constraint
34{
35class Create : public IAction
36{
37public:
42
43public:
45
46
49 template<class StringT>
50 explicit Create(const StringT& areaname,
52 Data::BindingConstraint::Operator o);
56 template<class StringT1, class StringT2>
57 Create(const StringT1& areaname,
58 const StringT2& targetname,
60 Data::BindingConstraint::Operator o);
61
63 virtual ~Create();
65
70
71 virtual bool allowUpdate() const;
72
73protected:
74 virtual void prepareSkipWL(Context& ctx);
75 virtual bool prepareWL(Context& ctx);
76 virtual bool performWL(Context& ctx);
77
78private:
80 Antares::Data::ConstraintName pOriginalConstraintName;
81 Antares::Data::ConstraintName pTargetConstraintName;
82 Antares::Data::ConstraintName pFuturConstraintName;
84 Antares::Data::BindingConstraint::Operator pOperator;
85
86}; // class IAction
87
88} // namespace Constraint
89} // namespace AntaresStudy
90} // namespace Action
91} // namespace Antares
92
93#include "create.hxx"
94
95#endif // __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_CONSTRAINT_CREATE_H__
Definition antares-study.h:28
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition create.h:39
virtual void prepareSkipWL(Context &ctx)
Prepare the execution (when the behavior says that the action should be skipped)
Definition create.cpp:43
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition create.h:41
virtual bool performWL(Context &ctx)
Perform the action.
Definition create.cpp:166
virtual ~Create()
Destructor.
Definition create.hxx:51
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition create.cpp:55
void createActionsForAStandardConstraintCopy(Context &ctx)
Create all standard actions for copy/pasting an area.
Definition create.cpp:206
Create(const StringT &areaname, Data::BindingConstraint::Type t, Data::BindingConstraint::Operator o)
Default constructor.
Definition create.hxx:33
Definition context.h:38
Definition action.h:38
AncestorType::Ptr Ptr
The most suitable smart ptr for the class.
Definition action.h:43
AncestorType::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition action.h:45
Type
Definition BindingConstraint.h:55