Antares Simulator
Power System Simulator
Loading...
Searching...
No Matches
layer.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_WINDOWS_OUTPUT_LAYER_H__
22#define __ANTARES_WINDOWS_OUTPUT_LAYER_H__
23
24#include "../../application/study.h"
25#include "fwd.h"
26
27namespace Antares
28{
29namespace Window
30{
31namespace OutputViewer
32{
33class Layer
34{
35public:
37 using Vector = std::vector<Layer*>;
38
39public:
41
42
45 Layer(LayerType t = ltOutput);
49 Layer(const Layer& rhs);
51 ~Layer();
53
57 const wxString& alternativeCaption() const;
58
60 bool isVirtual() const;
61
62public:
64 uint index;
68 const LayerType type;
69
73 SelectionType customSelectionType;
75 Yuni::String customAreaOrLink;
76
77private:
78 void resetAlternativeCaption();
79
80private:
82 wxString pAlternativeCaption;
83
84}; // class Layer
85
86} // namespace OutputViewer
87} // namespace Window
88} // namespace Antares
89
90#include "layer.hxx"
91
92#endif // __ANTARES_WINDOWS_OUTPUT_LAYER_H__
std::shared_ptr< Output > Ptr
Smartptr.
Definition output.h:43
SelectionType customSelectionType
Custom selection type (only valid if detached)
Definition layer.h:73
const wxString & alternativeCaption() const
Get the alternative caption (for virtual layers)
Definition layer.hxx:30
std::vector< Layer * > Vector
Array.
Definition layer.h:37
bool isVirtual() const
Get if the layer is virtual.
Definition layer.hxx:35
Yuni::String customAreaOrLink
Custom area / link selection (only valid if detached)
Definition layer.h:75
const LayerType type
Type of the layer.
Definition layer.h:68
Layer(LayerType t=ltOutput)
Default constructor.
Definition layer.cpp:30
~Layer()
Destructor.
Definition layer.cpp:46
bool detached
Flag to know if the selection of the layer is detached from the global selection.
Definition layer.h:71
Data::Output::Ptr selection
The output.
Definition layer.h:66
uint index
Index of the output.
Definition layer.h:64