Antares Simulator
Power System Simulator
correlation-post.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_AREA_CORRELATION_POST_H__
22 #define __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_AREA_CORRELATION_POST_H__
23 
24 #include <yuni/yuni.h>
25 #include <action/action.h>
26 
27 namespace Antares::Action::AntaresStudy::Area
28 {
29 class CorrelationPost: public IAction
30 {
31 public:
33  using Ptr = IAction::Ptr;
36 
37 public:
39 
40 
43  explicit CorrelationPost(IAction* parent, Data::TimeSeriesType ts, const AnyString& areaname);
45  virtual ~CorrelationPost();
47 
48  virtual bool visible() const;
49 
50 protected:
51  virtual bool prepareWL(Context& ctx);
52  virtual bool performWL(Context& ctx);
53 
54 private:
56  IAction::Ptr pAction;
57  Data::TimeSeriesType pType;
58  Data::AreaName pOriginalAreaName;
59 
60 }; // class IAction
61 
62 } // namespace Antares::Action::AntaresStudy::Area
63 
64 #include "correlation-post.hxx"
65 
66 #endif // __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_AREA_CORRELATION_POST_H__
virtual bool performWL(Context &ctx)
Perform the action.
Definition: correlation-post.cpp:47
virtual bool visible() const
Get if the action should be visible to the user.
Definition: correlation-post.hxx:26
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition: correlation-post.h:33
virtual ~CorrelationPost()
Destructor.
Definition: correlation-post.cpp:36
CorrelationPost(IAction *parent, Data::TimeSeriesType ts, const AnyString &areaname)
Default constructor.
Definition: correlation-post.cpp:26
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition: correlation-post.cpp:40
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition: correlation-post.h:35
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