Ioss_FieldManager.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_Field.h" // for Field, Field::RoleType
#include <cstddef>      // for size_t
#include <string>       // for string
#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 FieldMapType = tsl::robin_pg_map<std::string, Field>;
#else
  using FieldMapType = std::unordered_map<std::string, Field>;
#endif
  using FieldValuePair = FieldMapType::value_type;
 
  /** \brief A collection of Ioss::Field objects.
   */
  class IOSS_EXPORT FieldManager
  {
  public:
    FieldManager() = default;
    FieldManager(const FieldManager &other)
        : fields(other.fields)
    { /* Do not make this `=default` since that breaks the thread-safe build */ }
 
    FieldManager &operator=(const FieldManager &) = delete;
 
    // If a field with the same 'name' exists, an exception will be thrown.
    // Add the specified field to the list.
    void add(const Field &new_field);
 
    // Remove all fields of type `role`
    void erase(Field::RoleType role);
 
    // Assumes: Field 'name' must exist.
    void erase(const std::string &field_name);
 
    // Checks if a field with 'field_name' exists in the database.
    bool exists(const std::string &field_name) const;
 
    IOSS_NODISCARD Field        get(const std::string &field_name) const;
    IOSS_NODISCARD const Field &getref(const std::string &field_name) const;
 
    // Returns the names of all fields
    int                     describe(NameList *names) const;
    IOSS_NODISCARD NameList describe() const;
 
    // Returns the names of all fields with the specified 'RoleType'
    int                     describe(Field::RoleType role, NameList *names) const;
    IOSS_NODISCARD NameList describe(Field::RoleType role) const;
 
    IOSS_NODISCARD size_t count() const;
 
  private:
    FieldMapType fields;
#if defined(IOSS_THREADSAFE)
    mutable std::mutex m_;
#endif
  };
} // namespace Ioss