Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
offsets.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_CONSTRAINT_OFFSETS_H__
22#define __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_CONSTRAINT_OFFSETS_H__
23
24#include <yuni/yuni.h>
25#include <action/action.h>
26
27namespace Antares
28{
29namespace Action
30{
31namespace AntaresStudy
32{
33namespace Constraint
34{
35class Offsets : public IAction
36{
37public:
42
43public:
45
46
49 Offsets(const AnyString& name, Antares::Data::ConstraintName targetName = "");
50
52 virtual ~Offsets();
54
55protected:
56 virtual bool prepareWL(Context& ctx);
57 virtual bool performWL(Context& ctx);
58 void translate(Antares::Data::AreaName& out, const Antares::Data::AreaName& original);
59 void toLower(Antares::Data::AreaName& out, const Antares::Data::AreaName& original);
60
61private:
63 Antares::Data::ConstraintName pOriginalConstraintName;
64 Antares::Data::ConstraintName targetName;
65 Context* pCurrentContext;
66
67}; // class IAction
68
69} // namespace Constraint
70} // namespace AntaresStudy
71} // namespace Action
72} // namespace Antares
73
74#endif // __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_CONSTRAINT_OFFSETS_H__
Definition antares-study.h:28
virtual bool performWL(Context &ctx)
Perform the action.
Definition offsets.cpp:87
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition offsets.h:41
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition offsets.cpp:45
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition offsets.h:39
virtual ~Offsets()
Destructor.
Definition offsets.cpp:41
Offsets(const AnyString &name, Antares::Data::ConstraintName targetName="")
Default constructor.
Definition offsets.cpp:35
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