resultdescriptor.h

Go to the documentation of this file.

 
#ifndef OPENSWMMVIS_PLOT_RESULTDESCRIPTOR_H
#define OPENSWMMVIS_PLOT_RESULTDESCRIPTOR_H
 
#include "plot/plotattribute.h"
 
#include <QString>
#include <QVector>
 
namespace openswmmvis::plot {
 
struct ResultDescriptor {
    PlotAttribute attr = PlotAttribute::Unknown;
 
    QString species;
 
    [[nodiscard]] bool isSpecies() const noexcept
    { return attr == PlotAttribute::Unknown && !species.isEmpty(); }
 
    [[nodiscard]] bool isValid() const noexcept
    { return attr != PlotAttribute::Unknown || !species.isEmpty(); }
 
    [[nodiscard]] QString label() const;
 
    [[nodiscard]] QString unitLabel(UnitSystem u,
                                    const QString &concentrationUnit =
                                        QStringLiteral("mg/L")) const;
 
    static ResultDescriptor forAttribute(PlotAttribute a)
    { ResultDescriptor d; d.attr = a; return d; }
 
    static ResultDescriptor forSpecies(const QString &name)
    { ResultDescriptor d; d.species = name; return d; }
 
    bool operator==(const ResultDescriptor &o) const noexcept
    { return attr == o.attr && species == o.species; }
    bool operator!=(const ResultDescriptor &o) const noexcept
    { return !(*this == o); }
};
 
} // namespace openswmmvis::plot
 
#endif // OPENSWMMVIS_PLOT_RESULTDESCRIPTOR_H