StripChart.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 <QtWidgets/QWidget>
#include <QtGui/QColor>
#include <QtCore/QVector>
#include <QtCore/QDateTime>
#include <chrono>
#include <memory>
 
namespace QtIndustrialWidgets {
 
class StripChartPrivate;
class StripChartTestAccess;
namespace internal {
class StripChartTestAccess;
}
 
class QTINDUSTRIALWIDGETS_EXPORT StripChart : public QWidget
{
    Q_OBJECT
 
    Q_PROPERTY(int capacity READ capacity WRITE setCapacity NOTIFY capacityChanged)
    Q_PROPERTY(double yMinimum READ yMinimum WRITE setYMinimum NOTIFY yRangeChanged)
    Q_PROPERTY(double yMaximum READ yMaximum WRITE setYMaximum NOTIFY yRangeChanged)
    Q_PROPERTY(bool autoScaleY READ isAutoScaleY WRITE setAutoScaleY NOTIFY appearanceChanged)
    Q_PROPERTY(bool gridVisible READ isGridVisible WRITE setGridVisible NOTIFY appearanceChanged)
    Q_PROPERTY(bool legendVisible READ isLegendVisible WRITE setLegendVisible 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(int horizontalDivisions READ horizontalDivisions WRITE setHorizontalDivisions NOTIFY appearanceChanged)
    Q_PROPERTY(int verticalDivisions READ verticalDivisions WRITE setVerticalDivisions NOTIFY appearanceChanged)
    Q_PROPERTY(XAxisMode xAxisMode READ xAxisMode WRITE setXAxisMode NOTIFY xAxisModeChanged)
    Q_PROPERTY(DecimationMode decimationMode READ decimationMode WRITE setDecimationMode NOTIFY decimationModeChanged)
    Q_PROPERTY(Interpolation interpolation READ interpolation WRITE setInterpolation NOTIFY interpolationChanged)
    Q_PROPERTY(TimeLabelFormat timeLabelFormat READ timeLabelFormat WRITE setTimeLabelFormat NOTIFY timeLabelFormatChanged)
    Q_PROPERTY(double timeSpanSeconds READ timeSpanSeconds WRITE setTimeSpanSeconds NOTIFY timeSpanChanged)
 
public:
    enum class XAxisMode {
        SampleIndex, 
        Time         
    };
    Q_ENUM(XAxisMode)
 
    
    enum class DecimationMode {
        Off,    
        Auto,   
        Always  
    };
    Q_ENUM(DecimationMode)
 
    
    enum class Interpolation {
        Linear, 
        Step    
    };
    Q_ENUM(Interpolation)
 
    
    enum class TimeLabelFormat {
        Relative, 
        Absolute  
    };
    Q_ENUM(TimeLabelFormat)
 
public:
    explicit StripChart(QWidget *parent = nullptr);
    ~StripChart() override;
 
    [[nodiscard]] int capacity() const;
    [[nodiscard]] double yMinimum() const;
    [[nodiscard]] double yMaximum() const;
    [[nodiscard]] bool isAutoScaleY() const;
    [[nodiscard]] bool isGridVisible() const;
    [[nodiscard]] bool isLegendVisible() const;
    [[nodiscard]] QColor gridColor() const;
    [[nodiscard]] QColor backgroundColor() const;
    [[nodiscard]] QColor bezelColor() const;
    [[nodiscard]] int horizontalDivisions() const;
    [[nodiscard]] int verticalDivisions() const;
 
    [[nodiscard]] int channelCount() const;
    [[nodiscard]] QString channelName(int channelId) const;
    [[nodiscard]] QColor channelColor(int channelId) const;
    [[nodiscard]] bool isChannelVisible(int channelId) const;
    [[nodiscard]] double channelPenWidth(int channelId) const;
    [[nodiscard]] qsizetype channelSampleCount(int channelId) const;
    [[nodiscard]] double channelLatestValue(int channelId) const;
 
    [[nodiscard]] XAxisMode xAxisMode() const;
    void setXAxisMode(XAxisMode mode);
 
    [[nodiscard]] std::chrono::nanoseconds timeSpan() const;
    void setTimeSpan(std::chrono::nanoseconds span);
 
    [[nodiscard]] double timeSpanSeconds() const;
    void setTimeSpanSeconds(double seconds);
 
    [[nodiscard]] DecimationMode decimationMode() const;
    void setDecimationMode(DecimationMode mode);
 
    [[nodiscard]] Interpolation interpolation() const;
    void setInterpolation(Interpolation interp);
 
    [[nodiscard]] std::chrono::nanoseconds gapThreshold() const;
    void setGapThreshold(std::chrono::nanoseconds threshold);
 
    [[nodiscard]] QDateTime timeOrigin() const;
    void setTimeOrigin(const QDateTime &origin);
 
    [[nodiscard]] TimeLabelFormat timeLabelFormat() const;
    void setTimeLabelFormat(TimeLabelFormat format);
 
    [[nodiscard]] quint64 rejectedSampleCount(int channelId) const;
    [[nodiscard]] bool isTimeWindowFullyCovered() const;
 
    void addSample(int channelId, std::chrono::nanoseconds t, double value);
 
    void addSamples(int channelId, const std::chrono::nanoseconds *t,
                    const double *values, qsizetype count);
 
    void addUniformSamples(int channelId, std::chrono::nanoseconds t0,
                           std::chrono::nanoseconds dt,
                           const double *values, qsizetype count);
 
    void addSynchronousSamples(std::chrono::nanoseconds t,
                               const QVector<double> &values);
 
    [[nodiscard]] QSize sizeHint() const override;
    [[nodiscard]] QSize minimumSizeHint() const override;
 
public Q_SLOTS:
    int addChannel(const QString &name, const QColor &color, double penWidth = 1.8);
    void addDataPoint(int channelId, double value);
    void addDataPoints(const QVector<double> &values);
    void clear();
 
    void setCapacity(int count);
    void setYMinimum(double min);
    void setYMaximum(double max);
    void setYRange(double min, double max);
    void setAutoScaleY(bool autoScale);
    void setGridVisible(bool visible);
    void setLegendVisible(bool visible);
    void setGridColor(const QColor &color);
    void setBackgroundColor(const QColor &color);
    void setBezelColor(const QColor &color);
    void setHorizontalDivisions(int divisions);
    void setVerticalDivisions(int divisions);
    void setChannelVisible(int channelId, bool visible);
    void setChannelColor(int channelId, const QColor &color);
 
Q_SIGNALS:
    void capacityChanged(int capacity);
    void yRangeChanged(double min, double max);
    void dataAdded();
    void appearanceChanged();
    void xAxisModeChanged(XAxisMode mode);
    void decimationModeChanged(DecimationMode mode);
    void interpolationChanged(Interpolation interp);
    void timeLabelFormatChanged(TimeLabelFormat format);
    void timeSpanChanged(double seconds);
 
protected:
    void paintEvent(QPaintEvent *event) override;
    void resizeEvent(QResizeEvent *event) override;
    void changeEvent(QEvent *event) override;
 
private:
    void invalidateCache();
    void renderStaticGrid(const QSize &size);
    void updateAutoScaling();
    void ensureAutoScale();
    [[nodiscard]] QRectF plotArea() const;
 
    std::unique_ptr<StripChartPrivate> d_ptr;
    Q_DECLARE_PRIVATE(StripChart)
    friend class StripChartTestAccess;
    friend class internal::StripChartTestAccess;
};
 
} // namespace QtIndustrialWidgets