populateDefaultMetadata -> commitStructuralSetup

available on all attributables

Author: franzpoeschel

include/openPMD/Iteration.hpp

@@ -185,6 +185,7 @@ class Iteration
     template <typename>
     friend struct traits::GenerationPolicy;
     friend class internal::ScientificDefaults;
+    friend class Attributable;
 
 public:
     Iteration(Iteration const &) = default;
@@ -307,11 +308,6 @@ class Iteration
         particles.visitHierarchy(v);
     }
 
-    // TODO: make this available on every class that inherits from
-    // scientificdefaults for this, somehow make visitHierarchy a non-template,
-    // so we can use it as a virtual function of attributable
-    void populateDefaultMetadata();
-
     Meshes meshes{};
     Particles particles{}; // particleSpecies?
 

include/openPMD/Mesh.hpp

@@ -44,6 +44,7 @@ class Mesh : public BaseRecord<MeshRecordComponent>
     friend class Container<Mesh>;
     friend class Iteration;
     friend class internal::ScientificDefaults;
+    friend class Attributable;
 
 public:
     Mesh(Mesh const &) = default;

include/openPMD/ParticleSpecies.hpp

@@ -42,6 +42,7 @@ class ParticleSpecies
     template <typename T>
     friend T &internal::makeOwning(T &self, Series);
     friend class internal::ScientificDefaults;
+    friend class Attributable;
 
 public:
     ParticlePatches particlePatches;

include/openPMD/RecordComponent.hpp

@@ -133,6 +133,7 @@ class RecordComponent
     template <typename T>
     friend T &internal::makeOwning(T &self, Series);
     friend class internal::ScientificDefaults;
+    friend class Attributable;
 
 public:
     enum class Allocation

include/openPMD/backend/Attributable.hpp

@@ -408,6 +408,8 @@ class Attributable
     template <typename Lambda>
     void visitHierarchyFromLambda(Lambda &&lambda);
 
+    void commitStructuralSetup();
+
     [[nodiscard]] OpenpmdStandard openPMDStandard() const;
 
     // clang-format off

include/openPMD/backend/BaseRecordComponent.hpp

@@ -82,6 +82,7 @@ class BaseRecordComponent : virtual public Attributable
 {
     template <typename T, typename T_key, typename T_container>
     friend class Container;
+    friend class Attributable;
 
 public:
     /*

include/openPMD/backend/HierarchyVisitorImpl.hpp

@@ -14,11 +14,15 @@ class HierarchyVisitorFromLambda : public HierarchyVisitor
 {
     Lambda lambda;
 
-public:
     template <typename Arg>
     HierarchyVisitorFromLambda(uint8_t /* constructor_tag */, Arg &&arg)
         : lambda(std::forward<Arg>(arg))
     {}
+
+    template <typename Lambda_in>
+    friend auto makeHierarchyVisitorFromLambda(Lambda_in &&lambda);
+
+public:
     void operator()(Iteration &obj) override
     {
         lambda(obj);

src/Iteration.cpp

@@ -34,7 +34,6 @@
 #include "openPMD/auxiliary/Variant.hpp"
 #include "openPMD/backend/Attributable.hpp"
 #include "openPMD/backend/BaseRecordComponent.hpp"
-#include "openPMD/backend/HierarchyVisitorImpl.hpp"
 #include "openPMD/backend/Variant_internal.hpp"
 #include "openPMD/backend/Writable.hpp"
 #include "openPMD/backend/scientific_defaults/ConfigAttribute.hpp"
@@ -128,7 +127,7 @@ Iteration &Iteration::close(bool _flush)
 
     // if (access::write(IOHandler()->m_frontendAccess))
     // {
-    //     populateDefaultMetadata();
+    //     commitStructuralSetup();
     // }
 
     if (_flush)
@@ -245,41 +244,6 @@ bool Iteration::closedByWriter() const
     }
 }
 
-void Iteration::populateDefaultMetadata()
-{
-    auto standard = IOHandler()->m_standard;
-    visitHierarchyFromLambda([standard](auto &component) {
-        using ComponentType = std::remove_reference_t<decltype(component)>;
-        if constexpr (auxiliary::IsTemplateBaseOf_v<BaseRecord, ComponentType>)
-        {
-            if (component.empty() && !component.datasetDefined())
-            {
-                std::cerr
-                    << "Cannot flush Record without any contained components:'"
-                    << component.myPath().openPMDPath() << "'. Will ignore.";
-                if (component.written())
-                {
-                    std::cerr
-                        << "\n(Note: The Record seems to have been written "
-                           "previously?)";
-                }
-                std::cerr << std::endl;
-                return;
-            }
-        }
-
-        if constexpr (
-            !std::is_same_v<ComponentType, Iterations> &&
-            !std::is_same_v<ComponentType, Meshes> &&
-            !std::is_same_v<ComponentType, ParticlePatches> &&
-            !std::is_same_v<ComponentType, Particles> &&
-            !std::is_same_v<ComponentType, Series>)
-        {
-            component.writeDefaults(standard);
-        }
-    });
-}
-
 void Iteration::flushFileBased(
     std::string const &filename,
     IterationIndex_t i,

src/backend/Attributable.cpp

@@ -27,6 +27,7 @@
 #include "openPMD/auxiliary/DerefDynamicCast.hpp"
 #include "openPMD/auxiliary/StringManip.hpp"
 #include "openPMD/backend/Attribute.hpp"
+#include "openPMD/backend/HierarchyVisitorImpl.hpp"
 
 #include <algorithm>
 #include <complex>
@@ -300,6 +301,37 @@ void Attributable::visitHierarchy(HierarchyVisitor &)
     throw std::runtime_error("Cannot call this on base class");
 }
 
+void Attributable::commitStructuralSetup()
+{
+    auto standard = IOHandler()->m_standard;
+    visitHierarchyFromLambda([standard](auto &component) {
+        using ComponentType = std::remove_reference_t<decltype(component)>;
+        if constexpr (auxiliary::IsTemplateBaseOf_v<BaseRecord, ComponentType>)
+        {
+            if (component.empty() && !component.datasetDefined())
+            {
+                std::cerr
+                    << "Cannot flush Record without any contained components:'"
+                    << component.myPath().openPMDPath() << "'. Will ignore.";
+                if (component.written())
+                {
+                    std::cerr
+                        << "\n(Note: The Record seems to have been written "
+                           "previously?)";
+                }
+                std::cerr << std::endl;
+                return;
+            }
+        }
+
+        if constexpr (
+            std::is_base_of_v<internal::ScientificDefaults, ComponentType>)
+        {
+            component.writeDefaults(standard);
+        }
+    });
+}
+
 OpenpmdStandard Attributable::openPMDStandard() const
 {
     return IOHandler()->m_standard;

src/binding/python/Attributable.cpp

@@ -647,7 +647,8 @@ void init_Attributable(py::module &m)
             "comment", &Attributable::comment, &Attributable::setComment)
         // TODO remove in future versions (deprecated)
         .def("set_comment", &Attributable::setComment)
-        .def("my_path", &Attributable::myPath);
+        .def("my_path", &Attributable::myPath)
+        .def("commit_structural_setup", &Iteration::commitStructuralSetup);
 
     py::bind_vector<PyAttributeKeys>(m, "Attribute_Keys");
 }