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