Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
timeseries.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_TIMESERIES_H__
22#define __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_AREA_TIMESERIES_H__
23
24#include <yuni/yuni.h>
25#include <action/action.h>
26#include <antares/study/fwd.h>
27
28namespace Antares
29{
30namespace Action
31{
32namespace AntaresStudy
33{
34namespace Area
35{
36class DataTimeseries : public IAction
37{
38public:
43
44public:
46
47
50 DataTimeseries(Data::TimeSeriesType ts, const AnyString& areaname);
51
55 DataTimeseries(Data::TimeSeriesType ts, const AnyString& areaname, const AnyString& clustername);
56
58 virtual ~DataTimeseries();
60
61 virtual void datagridCaption(YString& title);
62
63 virtual void behaviorToText(Behavior behavior, YString& out);
64
65protected:
66 virtual bool prepareWL(Context& ctx);
67 virtual bool performWL(Context& ctx);
68 virtual void registerViewsWL(Context& ctx);
69
70private:
71 Data::TimeSeriesType pType;
72 Data::AreaName pOriginalAreaName;
73 Data::ClusterName pOriginalPlantName;
74
75}; // class IAction
76
77} // namespace Area
78} // namespace AntaresStudy
79} // namespace Action
80} // namespace Antares
81
82#endif // __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_AREA_TIMESERIES_H__
Definition antares-study.h:28
DataTimeseries(Data::TimeSeriesType ts, const AnyString &areaname)
Default constructor.
Definition timeseries.cpp:34
virtual void registerViewsWL(Context &ctx)
Register all views.
Definition timeseries.cpp:81
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition timeseries.cpp:105
virtual ~DataTimeseries()
Destructor.
Definition timeseries.cpp:70
virtual bool performWL(Context &ctx)
Perform the action.
Definition timeseries.cpp:120
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition timeseries.h:40
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition timeseries.h:42
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