speciesattributes.h

Go to the documentation of this file.

 
#ifndef OPENSWMM_LAYERS_SPECIESATTRIBUTES_H
#define OPENSWMM_LAYERS_SPECIESATTRIBUTES_H
 
#include <QSet>
#include <QString>
#include <QStringList>
 
namespace OpenSWMMVis::Species
{
 
inline constexpr const char *kWaterAgeName    = "__WATER_AGE__";
inline constexpr const char *kTemperatureName = "__TEMPERATURE__";
 
inline constexpr const char *kSpeciesAttrPrefix = "qual:";
 
[[nodiscard]] QString speciesAttributeName(const QString &species);
 
[[nodiscard]] bool isSpeciesAttribute(const QString &attr);
 
[[nodiscard]] QString speciesFromAttribute(const QString &attr);
 
[[nodiscard]] QString speciesDisplayLabel(const QString &species);
 
[[nodiscard]] QString speciesUnitLabel(const QString &species,
                                       const QString &concentrationUnit);
 
[[nodiscard]] bool isReservedSpecies(const QString &species);
 
[[nodiscard]] int speciesOutCode(const QString &attr,
                                 const QStringList &species,
                                 int pollutBase);
 
[[nodiscard]] QStringList inflowConstituentNames(const QStringList &pollutants);
 
[[nodiscard]] QString inflowConstituentLabel(const QString &name);
 
[[nodiscard]] bool inflowMassAllowed(const QString &name);
 
class SpeciesMissWarner
{
public:
    [[nodiscard]] QString noteMiss(const QString &attr,
                                   const QString &runName);
    void reset() { m_warned.clear(); }
 
private:
    QSet<QString> m_warned;
};
 
} // namespace OpenSWMMVis::Species
 
#endif // OPENSWMM_LAYERS_SPECIESATTRIBUTES_H