class_catalog.hpp

/****************************************************************************
 *
 * Copyright 2026 Auterion AG. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
 
#pragma once
 
#include <cstddef>
#include <cstdint>
#include <limits>
#include <map>
#include <optional>
#include <string>
#include <vector>
 
namespace auterion {
 
inline constexpr uint32_t kUnknownClassId{std::numeric_limits<uint32_t>::max()};
 
struct ClassEntry {
    std::string name{};  
    std::optional<std::string> color{};
    std::optional<std::string> category{};
};
 
class ClassCatalog {
   public:
    ClassCatalog() = default;
 
    static ClassCatalog fromModelOrder(const std::vector<std::string>& names_in_model_order);
 
    static ClassCatalog fromClassIds(const std::map<uint32_t, std::string>& class_id_to_name);
 
    static ClassCatalog fromEntries(const std::map<uint32_t, ClassEntry>& class_id_to_entry);
 
    bool empty() const { return _entries.empty(); }
 
    std::size_t size() const { return _entries.size(); }
 
    const std::map<uint32_t, ClassEntry>& entries() const { return _entries; }
 
   private:
    std::map<uint32_t, ClassEntry> _entries;
};
 
}  // namespace auterion