Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
correlation-post.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_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
27namespace Antares
28{
29namespace Action
30{
31namespace AntaresStudy
32{
33namespace Area
34{
36{
37public:
42
43public:
45
46
49 explicit CorrelationPost(IAction* parent, Data::TimeSeriesType ts, const AnyString& areaname);
51 virtual ~CorrelationPost();
53
54 virtual bool visible() const;
55
56protected:
57 virtual bool prepareWL(Context& ctx);
58 virtual bool performWL(Context& ctx);
59
60private:
62 IAction::Ptr pAction;
63 Data::TimeSeriesType pType;
64 Data::AreaName pOriginalAreaName;
65
66}; // class IAction
67
68} // namespace Area
69} // namespace AntaresStudy
70} // namespace Action
71} // namespace Antares
72
73#include "correlation-post.hxx"
74
75#endif // __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_AREA_CORRELATION_POST_H__
Definition antares-study.h:28
virtual bool performWL(Context &ctx)
Perform the action.
Definition correlation-post.cpp:49
virtual bool visible() const
Get if the action should be visible to the user.
Definition correlation-post.hxx:32
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition correlation-post.h:39
virtual ~CorrelationPost()
Destructor.
Definition correlation-post.cpp:38
CorrelationPost(IAction *parent, Data::TimeSeriesType ts, const AnyString &areaname)
Default constructor.
Definition correlation-post.cpp:32
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition correlation-post.cpp:42
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition correlation-post.h:41
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