Antares Simulator
Power System Simulator
dsm.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_TOOLBOX_COMPONENT_DATAGRID_RENDERER_AREA_DSM_H__
22 #define __ANTARES_TOOLBOX_COMPONENT_DATAGRID_RENDERER_AREA_DSM_H__
23 
24 #include "../area.h"
25 #include "../matrix.h"
26 #include <antares/date/date.h>
27 #include <antares/study/parts/wind/prepro.h>
28 
29 namespace Antares::Component::Datagrid::Renderer
30 {
31 class DSM final: public Renderer::Matrix<>, public Renderer::ARendererArea
32 {
33 public:
35 
36 
39  DSM(wxWindow* control, Toolbox::InputSelector::Area* notifier);
40 
42  virtual ~DSM();
43 
45 
46  virtual int width() const
47  {
49  }
50 
51  virtual int height() const
52  {
54  }
55 
56  virtual wxString columnCaption(int colIndx) const;
57 
58  virtual wxString rowCaption(int rowIndx) const
59  {
60  return Renderer::Matrix<>::rowCaption(rowIndx);
61  }
62 
63  virtual wxString cellValue(int x, int y) const
64  {
65  return Renderer::Matrix<>::cellValue(x, y);
66  }
67 
68  virtual double cellNumericValue(int x, int y) const
69  {
71  }
72 
73  virtual bool cellValue(int x, int y, const Yuni::String& value)
74  {
75  return Renderer::Matrix<>::cellValue(x, y, value);
76  }
77 
78  virtual void resetColors(int, int, wxColour&, wxColour&) const
79  { /*Do nothing*/
80  }
81 
82  virtual IRenderer::CellStyle cellStyle(int col, int row) const;
83 
84  virtual wxColour horizontalBorderColor(int x, int y) const;
85 
86  virtual uint maxWidthResize() const
87  {
88  return 0;
89  }
90 
91  virtual bool valid() const
92  {
94  }
95 
96  virtual Date::Precision precision()
97  {
98  return Date::hourly;
99  }
100 
101 protected:
102  virtual void internalAreaChanged(Antares::Data::Area* area);
103 
105  virtual void onStudyClosed() override;
107  virtual void onStudyLoaded() override;
108 
109 private:
111  Antares::Data::Area* pArea;
112 
113 }; // class DSM
114 
115 } // namespace Antares::Component::Datagrid::Renderer
116 
117 #endif // __ANTARES_TOOLBOX_COMPONENT_DATAGRID_RENDERER_AREA_DSM_H__
DSM(wxWindow *control, Toolbox::InputSelector::Area *notifier)
Constructor.
Definition: dsm.cpp:27
virtual int width() const
Get the current width.
Definition: dsm.h:46
virtual ~DSM()
Destructor.
Definition: dsm.cpp:33
virtual wxString cellValue(int x, int y) const
Get the string representation of a cell.
Definition: dsm.h:63
virtual uint maxWidthResize() const
The most suitable column count.
Definition: dsm.h:86
virtual void onStudyLoaded() override
Event: the study has been loaded.
Definition: dsm.cpp:96
virtual double cellNumericValue(int x, int y) const
Get the value of a cell.
Definition: dsm.h:68
virtual Date::Precision precision()
Time Precision.
Definition: dsm.h:96
virtual wxColour horizontalBorderColor(int x, int y) const
Get the color of the horizontal bottom border.
Definition: dsm.cpp:69
virtual int height() const
Get the current height.
Definition: dsm.h:51
virtual wxString rowCaption(int rowIndx) const
Get the row caption.
Definition: dsm.h:58
virtual bool cellValue(int x, int y, const Yuni::String &value)
Set the value of a cell.
Definition: dsm.h:73
virtual wxString columnCaption(int colIndx) const
Get the column caption.
Definition: dsm.cpp:38
virtual void onStudyClosed() override
Event: the study has been closed.
Definition: dsm.cpp:90
Definition for a single area.
Definition: area.h:51
A n-by-n matrix.
Definition: matrix.h:44
uint height
Height of the matrix.
Definition: matrix.h:443
uint width
Width of the matrix.
Definition: matrix.h:441
Visual Component for displaying all available areas (and groups)
Definition: area.h:37