AnalysisChart.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 Paolo Sereno <paolomsereno@gmail.com>
 *
 * SPDX-License-Identifier: MIT
 */
 
#pragma once
 
#include <QtIndustrialWidgets/qtindustrialwidgets_global.h>
 
#include <QtCore/QDateTime>
#include <QtCore/QList>
#include <QtCore/QStringList>
#include <QtGui/QColor>
#include <QtWidgets/QWidget>
 
#include <chrono>
#include <memory>
#include <optional>
 
namespace QtIndustrialWidgets {
 
class AnalysisChartPrivate;
namespace internal {
class AnalysisChartTestAccess;
}
 
class QTINDUSTRIALWIDGETS_EXPORT AnalysisChart : public QWidget
{
    Q_OBJECT
    Q_PROPERTY(double yMinimum READ yMinimum NOTIFY viewChanged)
    Q_PROPERTY(double yMaximum READ yMaximum NOTIFY viewChanged)
    Q_PROPERTY(bool gridVisible READ isGridVisible WRITE setGridVisible NOTIFY appearanceChanged)
    Q_PROPERTY(bool legendVisible READ isLegendVisible WRITE setLegendVisible NOTIFY appearanceChanged)
    Q_PROPERTY(bool readoutVisible READ isReadoutVisible WRITE setReadoutVisible NOTIFY appearanceChanged)
    Q_PROPERTY(QColor gridColor READ gridColor WRITE setGridColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor bezelColor READ bezelColor WRITE setBezelColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor textColor READ textColor WRITE setTextColor NOTIFY appearanceChanged)
    Q_PROPERTY(QColor cursorColor READ cursorColor WRITE setCursorColor NOTIFY appearanceChanged)
    Q_PROPERTY(DecimationMode decimationMode READ decimationMode WRITE setDecimationMode NOTIFY appearanceChanged)
    Q_PROPERTY(TimeLabelFormat timeLabelFormat READ timeLabelFormat WRITE setTimeLabelFormat NOTIFY appearanceChanged)
    Q_PROPERTY(QDateTime timeOrigin READ timeOrigin WRITE setTimeOrigin NOTIFY appearanceChanged)
 
public:
    enum class Cursor { A, B };
    Q_ENUM(Cursor)
 
    
    enum class DecimationMode {
        Off,    
        Auto,   
        Always  
    };
    Q_ENUM(DecimationMode)
 
    
    enum class TimeLabelFormat {
        Relative, 
        Absolute  
    };
    Q_ENUM(TimeLabelFormat)
 
    
    struct Sample {
        std::chrono::nanoseconds t{0};
        double value{0.0}; 
    };
 
    explicit AnalysisChart(QWidget *parent = nullptr);
    ~AnalysisChart() override;
 
    // --- Channels: ids are stable, never reused, and unaffected by removing other channels ---
 
    int addChannel(const QString &name, const QColor &color, double penWidth = 1.8);
    bool removeChannel(int channelId);
    void removeAllChannels();
    [[nodiscard]] QList<int> channelIds() const;
    [[nodiscard]] int channelCount() const;
    [[nodiscard]] QString channelName(int channelId) const;
    void setChannelName(int channelId, const QString &name);
    [[nodiscard]] QColor channelColor(int channelId) const;
    void setChannelColor(int channelId, const QColor &color);
    [[nodiscard]] bool isChannelVisible(int channelId) const;
    void setChannelVisible(int channelId, bool visible);
    [[nodiscard]] double channelPenWidth(int channelId) const;
    void setChannelPenWidth(int channelId, double width);
 
    // --- Data: copied, so the caller's buffers may be freed after the call ---
 
    bool setChannelData(int channelId, const std::chrono::nanoseconds *t, const double *values, qsizetype count);
    [[nodiscard]] qsizetype channelSampleCount(int channelId) const;
    [[nodiscard]] bool hasData() const;
    [[nodiscard]] std::chrono::nanoseconds dataStart() const;
    [[nodiscard]] std::chrono::nanoseconds dataEnd() const;
    [[nodiscard]] std::optional<Sample> nearestSample(int channelId, std::chrono::nanoseconds t) const;
 
    [[nodiscard]] std::chrono::nanoseconds gapThreshold() const;
    void setGapThreshold(std::chrono::nanoseconds threshold);
 
    // --- View ---
 
    [[nodiscard]] std::chrono::nanoseconds xStart() const;
    [[nodiscard]] std::chrono::nanoseconds xEnd() const;
    void setXRange(std::chrono::nanoseconds start, std::chrono::nanoseconds end);
    [[nodiscard]] double yMinimum() const;
    [[nodiscard]] double yMaximum() const;
    void setYRange(double minimum, double maximum);
 
    // --- Cursors ---
 
    [[nodiscard]] bool isCursorVisible(Cursor cursor) const;
    void setCursorVisible(Cursor cursor, bool visible);
    [[nodiscard]] std::chrono::nanoseconds cursorPosition(Cursor cursor) const;
    void setCursorPosition(Cursor cursor, std::chrono::nanoseconds t);
    [[nodiscard]] std::optional<Sample> cursorReadout(int channelId, Cursor cursor) const;
    [[nodiscard]] std::chrono::nanoseconds cursorDeltaTime() const;
    [[nodiscard]] std::optional<double> cursorDeltaValue(int channelId) const;
 
    // --- Appearance ---
 
    [[nodiscard]] bool isGridVisible() const;
    [[nodiscard]] bool isLegendVisible() const;
    [[nodiscard]] bool isReadoutVisible() const;
    [[nodiscard]] QColor gridColor() const;
    [[nodiscard]] QColor backgroundColor() const;
    [[nodiscard]] QColor bezelColor() const;
    [[nodiscard]] QColor textColor() const;
    [[nodiscard]] QColor cursorColor() const;
    [[nodiscard]] DecimationMode decimationMode() const;
    [[nodiscard]] TimeLabelFormat timeLabelFormat() const;
    [[nodiscard]] QDateTime timeOrigin() const;
 
    [[nodiscard]] QSize sizeHint() const override;
    [[nodiscard]] QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    void clear();
    void resetView();
    void setGridVisible(bool visible);
    void setLegendVisible(bool visible);
    void setReadoutVisible(bool visible);
    void setGridColor(const QColor &color);
    void setBackgroundColor(const QColor &color);
    void setBezelColor(const QColor &color);
    void setTextColor(const QColor &color);
    void setCursorColor(const QColor &color);
    void setDecimationMode(DecimationMode mode);
    void setTimeLabelFormat(TimeLabelFormat format);
    void setTimeOrigin(const QDateTime &origin);
 
Q_SIGNALS:
    void viewChanged();
    void channelsChanged();
    void cursorsChanged();
    void appearanceChanged();
 
protected:
    void paintEvent(QPaintEvent *event) override;
    void resizeEvent(QResizeEvent *event) override;
    void changeEvent(QEvent *event) override;
    void mousePressEvent(QMouseEvent *event) override;
    void mouseMoveEvent(QMouseEvent *event) override;
    void mouseReleaseEvent(QMouseEvent *event) override;
    void mouseDoubleClickEvent(QMouseEvent *event) override;
    void wheelEvent(QWheelEvent *event) override;
    void keyPressEvent(QKeyEvent *event) override;
 
private:
    [[nodiscard]] QRectF plotArea() const;
    [[nodiscard]] double readoutBandHeight() const;
    [[nodiscard]] double readoutBandWidth() const;
    [[nodiscard]] QList<QStringList> readoutRows() const;
    [[nodiscard]] qint64 readoutResolution() const;
    void clampViewToData();
 
    std::unique_ptr<AnalysisChartPrivate> d_ptr;
    Q_DECLARE_PRIVATE(AnalysisChart)
    friend class internal::AnalysisChartTestAccess;
};
 
} // namespace QtIndustrialWidgets