Tentatively working version

Author: franzpoeschel

include/openPMD/RecordComponent.hpp

@@ -329,6 +329,7 @@ OPENPMD_protected
 
     inline internal::RecordComponentData &get()
     {
+        datasetDefined();
         return *m_recordComponentData;
     }
 

include/openPMD/backend/Attributable.hpp

@@ -141,7 +141,7 @@ class Attributable
     friend class BaseRecord;
     template <typename T_elem>
     friend class BaseRecordInterface;
-    template <typename>
+    template <typename, typename>
     friend class internal::BaseRecordData;
     template <typename T, typename T_key, typename T_container>
     friend class Container;

include/openPMD/backend/BaseRecord.hpp

@@ -71,7 +71,7 @@ namespace internal
  */
 template <
     typename T_elem_maybe_void,
-    typename T_RecordComponent = RecordComponent>
+    typename T_RecordComponent = T_elem_maybe_void>
 class BaseRecord
     : public Container<
           typename auxiliary::OkOr<T_elem_maybe_void, BaseRecord<void> >::type>
@@ -91,18 +91,25 @@ class BaseRecord
     std::shared_ptr<internal::BaseRecordData<T_elem, T_RecordComponentData> >
         m_baseRecordData{
             new internal::BaseRecordData<T_elem, T_RecordComponentData>()};
+    using Data_t = internal::BaseRecordData<T_elem, T_RecordComponentData>;
 
-    inline internal::BaseRecordData<T_elem, T_RecordComponentData> &get()
+    inline Data_t &get()
     {
         return *m_baseRecordData;
     }
 
-    inline internal::BaseRecordData<T_elem, T_RecordComponentData> const &
-    get() const
+    inline Data_t const &get() const
     {
         return *m_baseRecordData;
     }
 
+    inline void setData(std::shared_ptr<Data_t> data)
+    {
+        m_baseRecordData = std::move(data);
+        T_Container::setData(m_baseRecordData);
+        T_RecordComponent::setData(m_baseRecordData);
+    }
+
     BaseRecord();
 
 public:
@@ -119,6 +126,14 @@ class BaseRecord
     using iterator = typename Container<T_elem>::iterator;
     using const_iterator = typename Container<T_elem>::const_iterator;
 
+    // this avoids object slicing
+    operator T_RecordComponent() const
+    {
+        T_RecordComponent res;
+        res.setData(m_baseRecordData);
+        return res;
+    }
+
     virtual ~BaseRecord() = default;
 
     mapped_type &operator[](key_type const &key) override;
@@ -160,11 +175,13 @@ class BaseRecord
     // BaseRecord(internal::BaseRecordData<T_elem> *);
     void readBase();
 
+    void datasetDefined() override;
+
 private:
     void flush(std::string const &, internal::FlushParams const &) final;
     virtual void
     flush_impl(std::string const &, internal::FlushParams const &) = 0;
-    virtual void read() = 0;
+    // virtual void read() = 0;
 
     /**
      * @brief Check recursively whether this BaseRecord is dirty.
@@ -195,7 +212,8 @@ namespace internal
 template <typename T_elem, typename T_RecordComponent>
 BaseRecord<T_elem, T_RecordComponent>::BaseRecord()
 {
-    Container<T_elem>::setData(m_baseRecordData);
+    T_Container::setData(m_baseRecordData);
+    T_RecordComponent::setData(m_baseRecordData);
 }
 
 template <typename T_elem, typename T_RecordComponent>
@@ -214,12 +232,12 @@ BaseRecord<T_elem, T_RecordComponent>::operator[](key_type const &key)
                 "A scalar component can not be contained at "
                 "the same time as one or more regular components.");
 
-        mapped_type &ret = Container<T_elem>::operator[](key);
         if (keyScalar)
         {
-            get().m_containsScalar = true;
-            ret.parent() = this->parent();
+            datasetDefined();
         }
+        mapped_type &ret = keyScalar ? static_cast<mapped_type &>(*this)
+                                     : T_Container::operator[](key);
         return ret;
     }
 }
@@ -240,12 +258,15 @@ BaseRecord<T_elem, T_RecordComponent>::operator[](key_type &&key)
                 "A scalar component can not be contained at "
                 "the same time as one or more regular components.");
 
-        mapped_type &ret = Container<T_elem>::operator[](std::move(key));
         if (keyScalar)
         {
-            get().m_containsScalar = true;
-            ret.parent() = this->parent();
+            datasetDefined();
         }
+        /*
+         * datasetDefined() inits the container entry
+         */
+        mapped_type &ret = keyScalar ? T_Container::at(std::move(key))
+                                     : T_Container::operator[](std::move(key));
         return ret;
     }
 }
@@ -406,4 +427,16 @@ inline bool BaseRecord<T_elem, T_RecordComponent>::dirtyRecursive() const
     }
     return false;
 }
+
+template <typename T_elem, typename T_RecordComponent>
+void BaseRecord<T_elem, T_RecordComponent>::datasetDefined()
+{
+    // If the RecordComponent API of this object has been used, then the record
+    // is a scalar one
+    T_RecordComponent copy;
+    copy.setData(m_baseRecordData);
+    T_Container::emplace(RecordComponent::SCALAR, std::move(copy));
+    get().m_containsScalar = true;
+    T_RecordComponent::datasetDefined();
+}
 } // namespace openPMD

include/openPMD/backend/BaseRecordComponent.hpp

@@ -119,6 +119,8 @@ class BaseRecordComponent : virtual public Attributable
         Attributable::setData(m_baseRecordComponentData);
     }
 
+    virtual void datasetDefined();
+
     BaseRecordComponent();
 }; // BaseRecordComponent
 

include/openPMD/backend/MeshRecordComponent.hpp

@@ -30,6 +30,8 @@ class MeshRecordComponent : public RecordComponent
 {
     template <typename T, typename T_key, typename T_container>
     friend class Container;
+    template <typename, typename>
+    friend class BaseRecord;
 
     friend class Mesh;
 
@@ -70,6 +72,9 @@ class MeshRecordComponent : public RecordComponent
      */
     template <typename T>
     MeshRecordComponent &makeConstant(T);
+
+protected:
+    void datasetDefined() override;
 };
 
 template <typename T>

include/openPMD/backend/PatchRecordComponent.hpp

@@ -92,7 +92,7 @@ OPENPMD_private
     // clang-format on
 
     void flush(std::string const &, internal::FlushParams const &);
-    void read();
+    virtual void read();
 
     /**
      * @brief Check recursively whether this RecordComponent is dirty.
@@ -104,8 +104,8 @@ OPENPMD_private
      */
     bool dirtyRecursive() const;
 
-    std::shared_ptr<internal::PatchRecordComponentData>
-        m_patchRecordComponentData{new internal::PatchRecordComponentData()};
+    std::shared_ptr<internal::PatchRecordComponentData> m_recordComponentData{
+        new internal::PatchRecordComponentData()};
 
     PatchRecordComponent();
 
@@ -115,19 +115,19 @@ OPENPMD_protected
 
     inline internal::PatchRecordComponentData const &get() const
     {
-        return *m_patchRecordComponentData;
+        return *m_recordComponentData;
     }
 
     inline internal::PatchRecordComponentData &get()
     {
-        return *m_patchRecordComponentData;
+        return *m_recordComponentData;
     }
 
     inline void
     setData(std::shared_ptr<internal::PatchRecordComponentData> data)
     {
-        m_patchRecordComponentData = std::move(data);
-        BaseRecordComponent::setData(m_patchRecordComponentData);
+        m_recordComponentData = std::move(data);
+        BaseRecordComponent::setData(m_recordComponentData);
     }
 }; // PatchRecordComponent
 

src/RecordComponent.cpp

@@ -79,6 +79,8 @@ RecordComponent &RecordComponent::resetDataset(Dataset d)
         throw error::WrongAPIUsage(
             "[RecordComponent] Must set specific datatype.");
     }
+
+    datasetDefined();
     // if( d.extent.empty() )
     //    throw std::runtime_error("Dataset extent must be at least 1D.");
     if (std::any_of(
@@ -167,6 +169,7 @@ RecordComponent &RecordComponent::makeEmpty(Dataset d)
     if (rc.m_dataset.extent.size() == 0)
         throw std::runtime_error("Dataset extent must be at least 1D.");
 
+    datasetDefined();
     rc.m_isEmpty = true;
     dirty() = true;
     if (!written())

src/backend/BaseRecordComponent.cpp

@@ -35,6 +35,7 @@ BaseRecordComponent &BaseRecordComponent::resetDatatype(Datatype d)
             "A Records Datatype can not (yet) be changed after it has been "
             "written.");
 
+    datasetDefined();
     get().m_dataset.dtype = d;
     return *this;
 }
@@ -69,4 +70,7 @@ BaseRecordComponent::BaseRecordComponent()
 {
     Attributable::setData(m_baseRecordComponentData);
 }
+
+void BaseRecordComponent::datasetDefined()
+{}
 } // namespace openPMD

src/backend/MeshRecordComponent.cpp

@@ -23,9 +23,7 @@
 namespace openPMD
 {
 MeshRecordComponent::MeshRecordComponent() : RecordComponent()
-{
-    setPosition(std::vector<double>{0});
-}
+{}
 
 void MeshRecordComponent::read()
 {
@@ -64,6 +62,12 @@ MeshRecordComponent &MeshRecordComponent::setPosition(std::vector<T> pos)
     return *this;
 }
 
+void MeshRecordComponent::datasetDefined()
+{
+    setPosition(std::vector<double>{0});
+    RecordComponent::datasetDefined();
+}
+
 template MeshRecordComponent &
 MeshRecordComponent::setPosition(std::vector<float> pos);
 template MeshRecordComponent &

src/backend/PatchRecordComponent.cpp

@@ -51,6 +51,7 @@ PatchRecordComponent &PatchRecordComponent::resetDataset(Dataset d)
         throw std::runtime_error(
             "Dataset extent must not be zero in any dimension.");
 
+    datasetDefined();
     get().m_dataset = d;
     dirty() = true;
     return *this;
@@ -68,7 +69,7 @@ Extent PatchRecordComponent::getExtent() const
 
 PatchRecordComponent::PatchRecordComponent()
 {
-    BaseRecordComponent::setData(m_patchRecordComponentData);
+    BaseRecordComponent::setData(m_recordComponentData);
     setUnitSI(1);
 }