Antares Simulator
Power System Simulator
timeseries.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_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 
28 namespace Antares::Action::AntaresStudy::Area
29 {
30 class DataTimeseries: public IAction
31 {
32 public:
34  using Ptr = IAction::Ptr;
37 
38 public:
40 
41 
44  DataTimeseries(Data::TimeSeriesType ts, const AnyString& areaname);
45 
49  DataTimeseries(Data::TimeSeriesType ts,
50  const AnyString& areaname,
51  const AnyString& clustername);
52 
54  virtual ~DataTimeseries();
56 
57  virtual void datagridCaption(YString& title);
58 
59  virtual void behaviorToText(Behavior behavior, YString& out);
60 
61 protected:
62  virtual bool prepareWL(Context& ctx);
63  virtual bool performWL(Context& ctx);
64  virtual void registerViewsWL(Context& ctx);
65 
66 private:
67  Data::TimeSeriesType pType;
68  Data::AreaName pOriginalAreaName;
69  std::string pOriginalPlantName;
70 
71 }; // class IAction
72 
73 } // namespace Antares::Action::AntaresStudy::Area
74 
75 #endif // __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_AREA_TIMESERIES_H__
DataTimeseries(Data::TimeSeriesType ts, const AnyString &areaname)
Default constructor.
Definition: timeseries.cpp:28
virtual void registerViewsWL(Context &ctx)
Register all views.
Definition: timeseries.cpp:80
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition: timeseries.cpp:104
virtual ~DataTimeseries()
Destructor.
Definition: timeseries.cpp:67
virtual bool performWL(Context &ctx)
Perform the action.
Definition: timeseries.cpp:119
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition: timeseries.h:34
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition: timeseries.h:36
Definition: context.h:36
Definition: action.h:36
AncestorType::Ptr Ptr
The most suitable smart ptr for the class.
Definition: action.h:41
Behavior behavior() const
Get the behavior.
Definition: action.hxx:36
AncestorType::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition: action.h:43