RumPiLinuxClientDocumentation/html/_main_window_8h_source.html

#pragma once


#include <wx/artprov.h>

#include <wx/xrc/xmlres.h>

#include <wx/intl.h>

#include <wx/panel.h>

#include <wx/gdicmn.h>

#include <wx/font.h>

#include <wx/colour.h>

#include <wx/settings.h>

#include <wx/string.h>

#include <wx/bitmap.h>

#include <wx/image.h>

#include <wx/icon.h>

#include <wx/notebook.h>

#include <wx/sizer.h>

#include <wx/frame.h>

#include <wx/menu.h>

#include <wx/msgdlg.h>

#include <wx/dataview.h>

#include <wx/stattext.h>

#include <wx/statbox.h>

#include <RumPi/Data/SelectedSensorReadings.h>

#include "../../Headers/LoggerEventForwarder.h"

#include "../../Headers/GUI/ComponentData.h"

#include "../../Headers/GUI/ComponentPanel.h"

#include "../../Headers/GUI/HomeScenePanel.h"

#include "../../Headers/GUI/LoggerListData.h"


//Owned by pointer, so a forward declaration keeps wx/thread.h and the poll-loop details out of this header.

class RumPiManagerThread;


wxDECLARE_EVENT(wxEVT_RUMPI_UPDATE, wxThreadEvent);


enum RumPiMenuID

{

    ID_SHOW_LOGS = 52

};


class MainWindow : public wxFrame

{

protected:

    wxNotebook* myNotebook;

    HomeScenePanel* myHomeScenePanel;

    wxPanel* mySummaryPanel;

    wxPanel* myDevicesPanel;

    wxPanel* myLoggerPanel;

    wxPanel* mySettingsPanel;


    //Devices Panel

    wxGridSizer* myDataViewGridSizer;

    wxScrolledWindow* myDevicesScrollWindow;


    //Logger Panel

    wxDataViewCtrl* myLoggerDataViewCtrl;

    LoggerListData* myLoggerListDataModel;

    LoggerEventForwarder* myLoggerEventForwarder;


    //Summary Panel: the live value label for each at-a-glance tile.

    wxStaticText* myTemperatureValue;

    wxStaticText* myHumidityValue;

    wxStaticText* myAirQualityValue;

    wxStaticText* myPmTwoPointFiveValue;

    wxStaticText* myTVOCValue;

    wxStaticText* myFormaldehydeValue;

    wxStaticText* myCO2Value;

    wxStaticText* myMotionValue;

    wxStaticText* myWindSpeedValue;

    wxStaticText* myLightValue;


    //One panel per component instance, keyed by the component's unique name (multiple components can share a type,

    //so the name - not the type - is the identity here).

    std::unordered_map<std::string, ComponentPanel*> myComponentDataCollection;


    //Background worker: polls RumPi and posts wxEVT_RUMPI_UPDATE to this window. Owned here so it can be stopped

    //and freed before the window is destroyed - it holds a pointer to us and must not outlive us.

    RumPiManagerThread* myRumPiManagerThread;


    void ConstructMenuAndStatusBar();


    void ConstructNotebook();


    void ConstructHomePanel();


    void ConstructSummaryPanel();


    void ConstructDevicesPanel();


    void ConstructLoggerPanel();


    void ConstructSettingsPanel();


    void TeardownBackgroundWork();


    wxStaticText* CreateSummaryTile(wxWindow* parent, wxSizer* tileGridSizer, const wxString& title);


    void UpdateSummaryPanel(const RumPi::SelectedSensorReadings& readings);


    virtual void OnClose(wxCloseEvent& event);


    virtual void OnExit(wxCommandEvent& event);


    virtual void OnAbout(wxCommandEvent& event);


    virtual void OnShowLogs(wxCommandEvent& event);


    virtual void OnRumPiUpdate(wxThreadEvent& event);


    void RefreshDeviceTiles(const std::string& componentJson);


    virtual void OnLoggerUpdate(wxThreadEvent& event);


public:

    MainWindow(wxWindow* parent, wxWindowID id = wxID_ANY, const wxString& title = wxEmptyString, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxSize(500, 300), long style = wxDEFAULT_FRAME_STYLE | wxTAB_TRAVERSAL);


    ~MainWindow();

};

wxDECLARE_EVENT
wxDECLARE_EVENT(wxEVT_RUMPI_UPDATE, wxThreadEvent)
Custom event carrying a component-data update from the manager thread to the UI.

RumPiMenuID
RumPiMenuID
Menu / control command IDs for the main window.
Definition: MainWindow.h:43

ID_SHOW_LOGS
@ ID_SHOW_LOGS
The "Show Log Files" menu item.
Definition: MainWindow.h:44

HomeScenePanel
The Home tab's stylized, condition-reactive backdrop.
Definition: HomeScenePanel.h:26

LoggerEventForwarder
Bridges the library's AlertManager to the wxWidgets event system: it subscribes to the AlertManager o...
Definition: LoggerEventForwarder.h:18

LoggerListData
A virtual list model backing the on-screen log's data-view control, holding the log lines and colouri...
Definition: LoggerListData.h:27

MainWindow
The client's main window: a tabbed frame (Home scene, Summary tiles, Devices, Logger,...
Definition: MainWindow.h:55

MainWindow::myAirQualityValue
wxStaticText * myAirQualityValue
The Air Quality tile's value label.
Definition: MainWindow.h:76

MainWindow::myPmTwoPointFiveValue
wxStaticText * myPmTwoPointFiveValue
The PM2.5 tile's value label.
Definition: MainWindow.h:77

MainWindow::ConstructLoggerPanel
void ConstructLoggerPanel()
Builds the Logger tab: a data-view control with icon/time/level/description columns,...
Definition: MainWindow.cpp:357

MainWindow::ConstructMenuAndStatusBar
void ConstructMenuAndStatusBar()
Builds the menu bar and status bar and binds the window's menu, update, logger, and close events.
Definition: MainWindow.cpp:95

MainWindow::OnExit
virtual void OnExit(wxCommandEvent &event)
Exit handler: closes the window.
Definition: MainWindow.cpp:473

MainWindow::ConstructSummaryPanel
void ConstructSummaryPanel()
Builds the Summary tab: a three-per-row grid of at-a-glance sensor tiles, stashing each tile's value ...
Definition: MainWindow.cpp:203

MainWindow::ConstructSettingsPanel
void ConstructSettingsPanel()
Builds the (currently empty) Settings tab and adds it to the notebook.
Definition: MainWindow.cpp:399

MainWindow::myFormaldehydeValue
wxStaticText * myFormaldehydeValue
The Formaldehyde tile's value label.
Definition: MainWindow.h:79

MainWindow::myTVOCValue
wxStaticText * myTVOCValue
The TVOC tile's value label.
Definition: MainWindow.h:78

MainWindow::myHomeScenePanel
HomeScenePanel * myHomeScenePanel
The Home tab's condition-reactive backdrop.
Definition: MainWindow.h:58

MainWindow::myLoggerPanel
wxPanel * myLoggerPanel
The Logger tab.
Definition: MainWindow.h:61

MainWindow::mySummaryPanel
wxPanel * mySummaryPanel
The Summary tab (at-a-glance tiles).
Definition: MainWindow.h:59

MainWindow::CreateSummaryTile
wxStaticText * CreateSummaryTile(wxWindow *parent, wxSizer *tileGridSizer, const wxString &title)
Builds one titled summary tile with a large centered value label and adds it to the grid.
Definition: MainWindow.cpp:247

MainWindow::OnRumPiUpdate
virtual void OnRumPiUpdate(wxThreadEvent &event)
RumPi-update handler (main thread): refreshes the Summary tiles and Home scene from the event's snaps...
Definition: MainWindow.cpp:549

MainWindow::RefreshDeviceTiles
void RefreshDeviceTiles(const std::string &componentJson)
Parses the component JSON payload and creates/refreshes one device tile per named component instance.
Definition: MainWindow.cpp:568

MainWindow::myWindSpeedValue
wxStaticText * myWindSpeedValue
The Wind Speed tile's value label.
Definition: MainWindow.h:82

MainWindow::myLoggerListDataModel
LoggerListData * myLoggerListDataModel
The model backing the log control.
Definition: MainWindow.h:70

MainWindow::ConstructNotebook
void ConstructNotebook()
Builds the notebook and its five tabs (Home, Summary, Devices, Logger, Settings) and adds it to the w...
Definition: MainWindow.cpp:139

MainWindow::myHumidityValue
wxStaticText * myHumidityValue
The Humidity tile's value label.
Definition: MainWindow.h:75

MainWindow::myMotionValue
wxStaticText * myMotionValue
The Motion tile's value label.
Definition: MainWindow.h:81

MainWindow::myComponentDataCollection
std::unordered_map< std::string, ComponentPanel * > myComponentDataCollection
Definition: MainWindow.h:87

MainWindow::myRumPiManagerThread
RumPiManagerThread * myRumPiManagerThread
Definition: MainWindow.h:91

MainWindow::myLoggerDataViewCtrl
wxDataViewCtrl * myLoggerDataViewCtrl
The data-view control showing the log.
Definition: MainWindow.h:69

MainWindow::MainWindow
MainWindow(wxWindow *parent, wxWindowID id=wxID_ANY, const wxString &title=wxEmptyString, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(500, 300), long style=wxDEFAULT_FRAME_STYLE|wxTAB_TRAVERSAL)
Builds the main window: sets up the menu/status bar and notebook, creates the alert forwarder,...
Definition: MainWindow.cpp:32

MainWindow::ConstructDevicesPanel
void ConstructDevicesPanel()
Builds the Devices tab: a scrollable, three-column grid that will hold one tile per component instanc...
Definition: MainWindow.cpp:320

MainWindow::myLoggerEventForwarder
LoggerEventForwarder * myLoggerEventForwarder
Forwards AlertManager alerts to the Logger tab.
Definition: MainWindow.h:71

MainWindow::TeardownBackgroundWork
void TeardownBackgroundWork()
Stops the background poll thread and then tears down the alert forwarder, in that order (stop the pro...
Definition: MainWindow.cpp:416

MainWindow::myDevicesPanel
wxPanel * myDevicesPanel
The Devices tab.
Definition: MainWindow.h:60

MainWindow::myTemperatureValue
wxStaticText * myTemperatureValue
The Temperature tile's value label.
Definition: MainWindow.h:74

MainWindow::OnLoggerUpdate
virtual void OnLoggerUpdate(wxThreadEvent &event)
Logger-update handler (main thread): appends the event's log line to the logger model.
Definition: MainWindow.cpp:647

MainWindow::UpdateSummaryPanel
void UpdateSummaryPanel(const RumPi::SelectedSensorReadings &readings)
Refreshes every summary tile's value label from a sensor snapshot (temperature, humidity,...
Definition: MainWindow.cpp:284

MainWindow::mySettingsPanel
wxPanel * mySettingsPanel
The Settings tab.
Definition: MainWindow.h:62

MainWindow::myLightValue
wxStaticText * myLightValue
The Light tile's value label.
Definition: MainWindow.h:83

MainWindow::ConstructHomePanel
void ConstructHomePanel()
Builds the Home tab's condition-reactive scene panel and adds it to the notebook.
Definition: MainWindow.cpp:182

MainWindow::myDataViewGridSizer
wxGridSizer * myDataViewGridSizer
The grid sizer holding the device tiles.
Definition: MainWindow.h:65

MainWindow::OnShowLogs
virtual void OnShowLogs(wxCommandEvent &event)
"Show Log Files" handler: opens the log folder in the platform's file manager, falling back to a mess...
Definition: MainWindow.cpp:509

MainWindow::myCO2Value
wxStaticText * myCO2Value
The CO2 tile's value label.
Definition: MainWindow.h:80

MainWindow::~MainWindow
~MainWindow()
Destroys the window, tearing down the background work as a safety net for paths that bypass OnClose (...
Definition: MainWindow.cpp:78

MainWindow::myDevicesScrollWindow
wxScrolledWindow * myDevicesScrollWindow
The scrollable container for the device tiles.
Definition: MainWindow.h:66

MainWindow::OnAbout
virtual void OnAbout(wxCommandEvent &event)
About handler: shows the application's about dialog.
Definition: MainWindow.cpp:490

MainWindow::myNotebook
wxNotebook * myNotebook
The tab container.
Definition: MainWindow.h:57

MainWindow::OnClose
virtual void OnClose(wxCloseEvent &event)
Close handler: tears down the background work before the window is destroyed (the worker and forwarde...
Definition: MainWindow.cpp:452

RumPiManagerThread
Background wxThread that runs the RumPi library's sensor loop and posts refreshed component data (and...
Definition: RumPiManagerThread.h:16