SpeciesRegistry.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: Apache-2.0
//
// Copyright 2026 Caleb Buahin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

 
#ifndef OPENSWMM_ENGINE_DATA_SPECIES_REGISTRY_HPP
#define OPENSWMM_ENGINE_DATA_SPECIES_REGISTRY_HPP
 
#include <string>
#include <string_view>
#include <vector>
 
namespace openswmm {

enum class SpeciesKind : int {
    POLLUTANT = 0,            
    RESERVED_AGE = 1,         
    RESERVED_TEMPERATURE = 2, 
    MSX_BULK = 3,             
    MSX_WALL = 4              
};
 
class SpeciesRegistry {
public:
    void clear() {
        name_.clear();
        kind_.clear();
        units_.clear();
        n_pollutants_ = 0;
    }

    int add(std::string name, SpeciesKind kind, std::string units) {
        if (find(name) >= 0)
            return -1;
        name_.push_back(std::move(name));
        kind_.push_back(kind);
        units_.push_back(std::move(units));
        if (kind == SpeciesKind::POLLUTANT)
            ++n_pollutants_;
        return static_cast<int>(name_.size()) - 1;
    }

    int find(std::string_view name) const {
        for (std::size_t i = 0; i < name_.size(); ++i)
            if (name_[i] == name)
                return static_cast<int>(i);
        return -1;
    }

    int count() const noexcept { return static_cast<int>(name_.size()); }
    int pollutant_count() const noexcept { return n_pollutants_; }

    int transported_count() const noexcept {
        int n = 0;
        for (const auto k : kind_)
            if (k == SpeciesKind::POLLUTANT || k == SpeciesKind::MSX_BULK ||
                k == SpeciesKind::RESERVED_AGE || k == SpeciesKind::RESERVED_TEMPERATURE)
                ++n;
        return n;
    }

    const std::string& name(int i) const { return name_[static_cast<std::size_t>(i)]; }
    SpeciesKind kind(int i) const { return kind_[static_cast<std::size_t>(i)]; }
    const std::string& units(int i) const { return units_[static_cast<std::size_t>(i)]; }

    void truncate_to(int n) {
        if (n < 0)
            n = 0;
        if (n >= count())
            return;
        const auto un = static_cast<std::size_t>(n);
        name_.resize(un);
        kind_.resize(un);
        units_.resize(un);
        n_pollutants_ = 0;
        for (const auto k : kind_)
            if (k == SpeciesKind::POLLUTANT)
                ++n_pollutants_;
    }
 
private:
    std::vector<std::string> name_;
    std::vector<SpeciesKind> kind_;
    std::vector<std::string> units_;
    int n_pollutants_ = 0;
};
 
} // namespace openswmm
 
#endif // OPENSWMM_ENGINE_DATA_SPECIES_REGISTRY_HPP