Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
comments.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_COMMENTS_H__
22
#define __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_CONSTRAINT_COMMENTS_H__
23
24
#include <yuni/yuni.h>
25
#include <action/action.h>
26
27
namespace
Antares
28
{
29
namespace
Action
30
{
31
namespace
AntaresStudy
32
{
33
namespace
Constraint
34
{
35
class
Comments
:
public
IAction
36
{
37
public
:
39
using
Ptr
=
IAction::Ptr
;
41
using
ThreadingPolicy
=
IAction::ThreadingPolicy
;
42
43
public
:
45
46
49
template
<
class
StringT>
50
Comments
(
const
StringT& name);
51
53
virtual
~Comments
();
55
56
protected
:
57
virtual
bool
prepareWL
(
Context
& ctx);
58
virtual
bool
performWL
(
Context
& ctx);
59
60
private
:
62
Antares::Data::ConstraintName pOriginalConstraintName;
63
64
};
// class IAction
65
66
}
// namespace Constraint
67
}
// namespace AntaresStudy
68
}
// namespace Action
69
}
// namespace Antares
70
71
#include "comments.hxx"
72
73
#endif
// __ANTARES_LIBS_STUDY_ACTION_HANDLER_ANTARES_CONSTRAINT_COMMENTS_H__
AntaresStudy
Definition
antares-study.h:28
Antares::Action::AntaresStudy::Constraint::Comments
Definition
comments.h:36
Antares::Action::AntaresStudy::Constraint::Comments::ThreadingPolicy
IAction::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition
comments.h:41
Antares::Action::AntaresStudy::Constraint::Comments::~Comments
virtual ~Comments()
Destructor.
Definition
comments.hxx:38
Antares::Action::AntaresStudy::Constraint::Comments::prepareWL
virtual bool prepareWL(Context &ctx)
Prepare the execution.
Definition
comments.cpp:33
Antares::Action::AntaresStudy::Constraint::Comments::Comments
Comments(const StringT &name)
Default constructor.
Definition
comments.hxx:33
Antares::Action::AntaresStudy::Constraint::Comments::Ptr
IAction::Ptr Ptr
The most suitable smart ptr for the class.
Definition
comments.h:39
Antares::Action::AntaresStudy::Constraint::Comments::performWL
virtual bool performWL(Context &ctx)
Perform the action.
Definition
comments.cpp:50
Antares::Action::Context
Definition
context.h:38
Antares::Action::IAction
Definition
action.h:38
Antares::Action::IAction::Ptr
AncestorType::Ptr Ptr
The most suitable smart ptr for the class.
Definition
action.h:43
Antares::Action::IAction::ThreadingPolicy
AncestorType::ThreadingPolicy ThreadingPolicy
The threading policy.
Definition
action.h:45
src
ui
action
handler
antares-study
constraint
comments.h
Generated by
1.12.0