Antares Simulator
Power System Simulator
watervalues.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_WATERVALUES_H__
22 #define __ANTARES_TOOLBOX_COMPONENT_DATAGRID_RENDERER_AREA_WATERVALUES_H__
23 
24 #include "../area.h"
25 #include "../matrix.h"
26 #include <antares/date/date.h>
27 
28 namespace Antares::Component::Datagrid::Renderer
29 {
30 class WaterValues final: public Renderer::Matrix<double, double, 2>, public Renderer::ARendererArea
31 {
32 public:
34 
35 public:
37 
38 
41  WaterValues(wxWindow* control, Toolbox::InputSelector::Area* notifier);
43  virtual ~WaterValues();
45 
46  virtual int width() const;
47  virtual int height() const;
48 
49  virtual wxString columnCaption(int colIndx) const;
50 
51  virtual wxString rowCaption(int rowIndx) const;
52 
53  virtual wxString cellValue(int x, int y) const;
54 
55  virtual double cellNumericValue(int x, int y) const;
56 
57  virtual bool cellValue(int, int, const Yuni::String&);
58 
59  virtual void resetColors(int, int, wxColour&, wxColour&) const
60  { /*Do nothing*/
61  }
62 
63  virtual Date::Precision precision()
64  {
65  return Date::daily;
66  }
67 
68  virtual IRenderer::CellStyle cellStyle(int col, int row) const;
69 
70  virtual bool valid() const;
71 
72  virtual uint maxWidthResize() const
73  {
74  return 0;
75  }
76 
77  virtual uint maxHeightResize() const
78  {
79  return 0;
80  }
81 
82  // virtual bool circularShiftRowsUntilDate(MonthName month, uint daymonth);
83 
84 protected:
85  virtual void internalAreaChanged(Antares::Data::Area* area);
87  virtual void onStudyClosed() override;
89  virtual void onStudyLoaded() override;
90 
91 }; // class InflowPattern
92 
93 } // namespace Antares::Component::Datagrid::Renderer
94 
95 #endif // __ANTARES_TOOLBOX_COMPONENT_DATAGRID_RENDERER_AREA_WATERVALUES_H__
virtual void onStudyLoaded() override
Event: the study has been loaded.
Definition: watervalues.cpp:140
virtual wxString cellValue(int x, int y) const
Get the string representation of a cell.
Definition: watervalues.cpp:61
virtual wxString rowCaption(int rowIndx) const
Get the row caption.
Definition: watervalues.cpp:113
virtual uint maxWidthResize() const
The most suitable column count.
Definition: watervalues.h:72
virtual double cellNumericValue(int x, int y) const
Get the value of a cell.
Definition: watervalues.cpp:66
virtual Date::Precision precision()
Time Precision.
Definition: watervalues.h:63
virtual bool cellValue(int, int, const Yuni::String &)
Set the value of a cell.
virtual int height() const
Get the current height.
Definition: watervalues.cpp:44
virtual int width() const
Get the current width.
Definition: watervalues.cpp:39
virtual wxString columnCaption(int colIndx) const
Get the column caption.
Definition: watervalues.cpp:49
WaterValues(wxWindow *control, Toolbox::InputSelector::Area *notifier)
Constructor.
Definition: watervalues.cpp:28
virtual uint maxHeightResize() const
The most suitable column count.
Definition: watervalues.h:77
virtual void onStudyClosed() override
Event: the study has been closed.
Definition: watervalues.cpp:134
virtual ~WaterValues()
Destructor.
Definition: watervalues.cpp:34
Definition for a single area.
Definition: area.h:51
A n-by-n matrix.
Definition: matrix.h:44
Visual Component for displaying all available areas (and groups)
Definition: area.h:37