Antares Simulator
Power System Simulator
ts-node.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_TS_NODE_H__
22 #define __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_AREA_TS_NODE_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 NodeTimeseries: public IAction
31 {
32 public:
34  using Ptr = IAction::Ptr;
37 
38 public:
40 
41 
44  NodeTimeseries(Data::TimeSeriesType ts);
46  virtual ~NodeTimeseries();
48 
49  virtual bool allowUpdate() const;
50 
51 protected:
52  virtual bool prepareWL(Context& ctx);
53  virtual bool performWL(Context& ctx);
54 
55 private:
57  const Data::TimeSeriesType pType;
58 
59 }; // class IAction
60 
61 } // namespace Antares::Action::AntaresStudy::Area
62 
63 #include "ts-node.hxx"
64 
65 #endif // __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_AREA_TS_NODE_H__
virtual bool performWL(Context &ctx)
Perform the action.
Definition: ts-node.cpp:76
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition: ts-node.cpp:61
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition: ts-node.h:36
virtual ~NodeTimeseries()
Destructor.
Definition: ts-node.cpp:57
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition: ts-node.h:34
NodeTimeseries(Data::TimeSeriesType ts)
Default constructor.
Definition: ts-node.cpp:29
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