Insert CustomHierarchy class to Iteration

Author: franzpoeschel

CMakeLists.txt

@@ -436,6 +436,7 @@ endif()
 set(CORE_SOURCE
         src/config.cpp
         src/ChunkInfo.cpp
+        src/CustomHierarchy.cpp
         src/Dataset.cpp
         src/Datatype.cpp
         src/Error.cpp

include/openPMD/CustomHierarchy.hpp

@@ -0,0 +1,61 @@
+/* Copyright 2023 Franz Poeschel
+ *
+ * This file is part of openPMD-api.
+ *
+ * openPMD-api is free software: you can redistribute it and/or modify
+ * it under the terms of of either the GNU General Public License or
+ * the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * openPMD-api is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License and the GNU Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * and the GNU Lesser General Public License along with openPMD-api.
+ * If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include "openPMD/backend/Container.hpp"
+
+#include <iostream>
+#include <type_traits>
+
+namespace openPMD
+{
+class CustomHierarchy;
+namespace internal
+{
+    using CustomHierarchyData = ContainerData<CustomHierarchy>;
+}
+
+class CustomHierarchy : public Container<CustomHierarchy>
+{
+    friend class Iteration;
+
+private:
+    using Container_t = Container<CustomHierarchy>;
+    using Data_t = typename Container_t::ContainerData;
+    static_assert(std::is_same_v<Data_t, internal::CustomHierarchyData>);
+
+protected:
+    CustomHierarchy();
+    CustomHierarchy(NoInit);
+
+    inline void setData(std::shared_ptr<Data_t> data)
+    {
+        Container_t::setData(std::move(data));
+    }
+
+public:
+    CustomHierarchy(CustomHierarchy const &other) = default;
+    CustomHierarchy(CustomHierarchy &&other) = default;
+
+    CustomHierarchy &operator=(CustomHierarchy const &) = default;
+    CustomHierarchy &operator=(CustomHierarchy &&) = default;
+};
+} // namespace openPMD

include/openPMD/Iteration.hpp

@@ -20,6 +20,7 @@
  */
 #pragma once
 
+#include "openPMD/CustomHierarchy.hpp"
 #include "openPMD/IterationEncoding.hpp"
 #include "openPMD/Mesh.hpp"
 #include "openPMD/ParticleSpecies.hpp"
@@ -79,7 +80,7 @@ namespace internal
         bool beginStep = false;
     };
 
-    class IterationData : public AttributableData
+    class IterationData : public CustomHierarchyData
     {
     public:
         /*
@@ -123,7 +124,7 @@ namespace internal
  * @see
  * https://github.com/openPMD/openPMD-standard/blob/latest/STANDARD.md#required-attributes-for-the-basepath
  */
-class Iteration : public Attributable
+class Iteration : public CustomHierarchy
 {
     template <typename T, typename T_key, typename T_container>
     friend class Container;
@@ -260,14 +261,19 @@ class Iteration : public Attributable
     inline void setData(std::shared_ptr<Data_t> data)
     {
         m_iterationData = std::move(data);
-        Attributable::setData(m_iterationData);
+        CustomHierarchy::setData(m_iterationData);
     }
 
     void flushFileBased(
         std::string const &, IterationIndex_t, internal::FlushParams const &);
     void flushGroupBased(IterationIndex_t, internal::FlushParams const &);
     void flushVariableBased(IterationIndex_t, internal::FlushParams const &);
-    void flush(internal::FlushParams const &);
+    /*
+     * Named flushIteration instead of flush to avoid naming
+     * conflicts with overridden virtual flush from CustomHierarchy
+     * class.
+     */
+    void flushIteration(internal::FlushParams const &);
     void deferParseAccess(internal::DeferredParseAccess);
     /*
      * Control flow for runDeferredParseAccess(), readFileBased(),

include/openPMD/backend/Container.hpp

@@ -101,10 +101,6 @@ template <
     typename T_container = std::map<T_key, T> >
 class Container : virtual public Attributable
 {
-    static_assert(
-        std::is_base_of<Attributable, T>::value,
-        "Type of container element must be derived from Writable");
-
     friend class Iteration;
     friend class ParticleSpecies;
     friend class ParticlePatches;
@@ -463,11 +459,32 @@ OPENPMD_protected
 
     Container() : Attributable(NoInit())
     {
+        /*
+         * This check cannot happen at the class scope, because T
+         * might still be an incomplete type, e.g. in
+         * class CustomHierarchy : public Container<CustomHierarchy>
+         * The next-best thing is doing the check in
+         * the constructor.
+         */
+        static_assert(
+            std::is_base_of<Attributable, T>::value,
+            "Type of container element must be derived from Writable");
         setData(std::make_shared<ContainerData>());
     }
 
     Container(NoInit) : Attributable(NoInit())
-    {}
+    {
+        /*
+         * This check cannot happen at the class scope, because T
+         * might still be an incomplete type, e.g. in
+         * class CustomHierarchy : public Container<CustomHierarchy>
+         * The next-best thing is doing the check in
+         * the constructor.
+         */
+        static_assert(
+            std::is_base_of<Attributable, T>::value,
+            "Type of container element must be derived from Writable");
+    }
 
 public:
     /*

include/openPMD/binding/python/Container.hpp

@@ -26,6 +26,7 @@
 
 #pragma once
 
+#include "openPMD/CustomHierarchy.hpp"
 #include "openPMD/backend/Attributable.hpp"
 
 #include <pybind11/pybind11.h>

src/CustomHierarchy.cpp

@@ -0,0 +1,28 @@
+/* Copyright 2023 Franz Poeschel
+ *
+ * This file is part of openPMD-api.
+ *
+ * openPMD-api is free software: you can redistribute it and/or modify
+ * it under the terms of of either the GNU General Public License or
+ * the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * openPMD-api is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License and the GNU Lesser General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * and the GNU Lesser General Public License along with openPMD-api.
+ * If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "openPMD/CustomHierarchy.hpp"
+
+namespace openPMD
+{
+CustomHierarchy::CustomHierarchy() = default;
+CustomHierarchy::CustomHierarchy(NoInit): Container_t(NoInit()) {}
+}

src/Iteration.cpp

@@ -36,7 +36,7 @@ namespace openPMD
 using internal::CloseStatus;
 using internal::DeferredParseAccess;
 
-Iteration::Iteration() : Attributable(NoInit())
+Iteration::Iteration() : CustomHierarchy(NoInit())
 {
     setData(std::make_shared<Data_t>());
     setTime(static_cast<double>(0));
@@ -231,7 +231,7 @@ void Iteration::flushFileBased(
     case FlushLevel::SkeletonOnly:
     case FlushLevel::InternalFlush:
     case FlushLevel::UserFlush:
-        flush(flushParams);
+        flushIteration(flushParams);
         break;
     }
 }
@@ -254,7 +254,7 @@ void Iteration::flushGroupBased(
     case FlushLevel::SkeletonOnly:
     case FlushLevel::InternalFlush:
     case FlushLevel::UserFlush:
-        flush(flushParams);
+        flushIteration(flushParams);
         break;
     }
 }
@@ -285,12 +285,12 @@ void Iteration::flushVariableBased(
     case FlushLevel::SkeletonOnly:
     case FlushLevel::InternalFlush:
     case FlushLevel::UserFlush:
-        flush(flushParams);
+        flushIteration(flushParams);
         break;
     }
 }
 
-void Iteration::flush(internal::FlushParams const &flushParams)
+void Iteration::flushIteration(internal::FlushParams const &flushParams)
 {
     if (access::readOnly(IOHandler()->m_frontendAccess))
     {

src/Series.cpp

@@ -764,7 +764,7 @@ void Series::flushFileBased(
                 break;
             case IO::HasBeenOpened:
                 // continue below
-                it->second.flush(flushParams);
+                it->second.flushIteration(flushParams);
                 break;
             }
 
@@ -874,7 +874,7 @@ void Series::flushGorVBased(
                 break;
             case IO::HasBeenOpened:
                 // continue below
-                it->second.flush(flushParams);
+                it->second.flushIteration(flushParams);
                 break;
             }