Ioss_PropertyManager.h

Go to the documentation of this file.

// Copyright(C) 1999-2024 National Technology & Engineering Solutions
// of Sandia, LLC (NTESS).  Under the terms of Contract DE-NA0003525 with
// NTESS, the U.S. Government retains certain rights in this software.
//
// See packages/seacas/LICENSE for details
 
#pragma once
 
#include "Ioss_CodeTypes.h"
#include "Ioss_Property.h" // for Property
#include <cstddef>         // for size_t
#include <stdint.h>
#include <string> // for string, operator<
#include <vector> // for vector
 
#include "ioss_export.h"
 
#define USE_ROBIN_MAP
#if defined USE_ROBIN_MAP
#include <robin_map.h>
#else
#include <unordered_map>
#endif
 
namespace Ioss {
#if defined USE_ROBIN_MAP
  using PropMapType = tsl::robin_pg_map<std::string, Property>;
#else
  using PropMapType = std::unordered_map<std::string, Property>;
#endif
  using ValuePair = PropMapType::value_type;
 
  /** \brief A collection of Ioss::Property objects
   */
  class IOSS_EXPORT PropertyManager
  {
  public:
    PropertyManager() = default;
    PropertyManager(const PropertyManager &from)
        : m_properties(from.m_properties)
    { /* Do not make this `=default` since that breaks the thread-safe build */ }
    PropertyManager &operator=(const PropertyManager &from) = delete;
 
    // Add the specified property to the list.
    void add(const Property &new_prop);
 
    // Assumes: Property 'name' must exist.
    void erase(const std::string &property_name);
 
    // Checks if a property with 'property_name' exists in the database.
    IOSS_NODISCARD bool exists(const std::string &property_name) const;
 
    IOSS_NODISCARD Property get(const std::string &property_name) const;
    IOSS_NODISCARD double   get_optional(const std::string &property_name,
                                         double             optional_value) const;
    IOSS_NODISCARD int64_t  get_optional(const std::string &property_name,
                                         int64_t            optional_value) const;
    IOSS_NODISCARD int get_optional(const std::string &property_name, int optional_value) const;
    IOSS_NODISCARD std::string get_optional(const std::string &property_name,
                                            const std::string &optional_value) const;
 
    // Returns the names of all properties
    int                     describe(NameList *names) const;
    IOSS_NODISCARD NameList describe() const;
 
    // Returns the names of all properties or origin `origin`
    int                     describe(Ioss::Property::Origin origin, NameList *names) const;
    IOSS_NODISCARD NameList describe(Ioss::Property::Origin origin) const;
 
    IOSS_NODISCARD size_t count() const;
 
  private:
    PropMapType m_properties{};
#if defined(IOSS_THREADSAFE)
    mutable std::mutex m_;
#endif
  };
} // namespace Ioss