BatteryWidget.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVR
File: BatteryWidget
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Battery.h>
#include <NDEVR/Button.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/UUID.h>
#include <QPointer>
class QLabel;
class QGridLayout;
namespace NDEVR
{
    class ProgressWidget;
    class Battery;
    class QCustomLabel;
    /**--------------------------------------------------------------------------------------------------
    \brief Listens for changes to a Battery and reports an error to the user when thresholds are crossed.
    **/
    class HARDWARE_WIDGETS_API BatteryAlertWatcher : public QObject
    {
        Q_OBJECT
    public:
        void addSensors(const Buffer<Battery*>& sensors);
        void removeSensors(const Buffer<Battery*>& sensors);
        static BatteryAlertWatcher& Default();
        void addLocalBatteries();
    protected slots:
        void stateChangeSlot(bool originator);
    protected:
        Dictionary<UUID, QPointer<Battery>> m_sensors;
    };
    /**--------------------------------------------------------------------------------------------------
    \brief A button that displays information about multiple Batteries when clicked. Button changes color
        based on the status of specified Battery objects.
    **/
    class HARDWARE_WIDGETS_API BatteryWidget : public Button
    {
        Q_OBJECT
    public:
        explicit BatteryWidget(QWidget* parent = nullptr);
        void setSensors(const Buffer<Battery*>& sensors);
        void setSensor(Battery* sensor);
        void addSensor(Battery* sensor, bool update = true);
        void removeSensor(Battery* sensor, bool update = true);
        void clearSensors(bool update = true);
        void setColumnCount(uint04 column_count);
        void addLocalBatteries();
    protected slots:
        void updatedSlot();
    protected:
        void updateLayout();
        [[nodiscard]] RGBColor getColor(uint04 state) const;
    protected:
        Dictionary<UUID, Battery*> m_sensors;
        Dictionary<UUID, ProgressWidget*> m_values;
        QWidget* m_battery_widget;
        QGridLayout* m_layout;
        uint04 m_column_count = 2;
    };
}