Data.hpp

Go to the documentation of this file.

#pragma once
 
#include <any>
#include <memory>
 
#include "io/BaseIO.hpp"
#include "nwb/RegisteredType.hpp"
#include "spec/hdmf_common.hpp"
 
namespace AQNWB::NWB
{
class Data : public RegisteredType
{
public:
  // Register the Data class with the type registry
  REGISTER_SUBCLASS(Data, RegisteredType, "hdmf-common")
 
protected:
  Data(const std::string& path, std::shared_ptr<IO::BaseIO> io);
 
public:
  virtual ~Data() override {}

  Status initialize(const IO::ArrayDataSetConfig& dataConfig);

  inline bool isInitialized() { return this->readData()->exists(); }
 
  // Define the data fields to expose for lazy read access
  DEFINE_DATASET_FIELD(readData, recordData, std::any, "", The main data)
 
  DEFINE_ATTRIBUTE_FIELD(readNeurodataType,
                         std::string,
                         "neurodata_type",
                         The name of the type)
 
  DEFINE_ATTRIBUTE_FIELD(readNamespace,
                         std::string,
                         "namespace",
                         The name of the namespace)
};

template<typename DTYPE = std::any>
class DataTyped : public Data
{
  friend class AQNWB::NWB::RegisteredType; /* base can call constructor */
 
protected:
  DataTyped(const std::string& path, std::shared_ptr<IO::BaseIO> io)
      : Data(path, io)
  {
  }
 
  using Data::Data; /* inherit from immediate base */
 
public:
  static std::shared_ptr<DataTyped> create(
      const std::string& path, std::shared_ptr<AQNWB::IO::BaseIO> io)
  {
    return RegisteredType::create<DataTyped>(path, io);
  }

  virtual ~DataTyped() override {}

  static std::shared_ptr<DataTyped<DTYPE>> fromData(
      const std::shared_ptr<Data>& data)
  {
    return DataTyped<DTYPE>::create(data->getPath(), data->getIO());
  }
 
  // Define the data fields to expose for lazy read access
  DEFINE_DATASET_FIELD(readData, recordData, DTYPE, "", The main data)
 
  using RegisteredType::getIO;
  using RegisteredType::getPath;
};
}  // namespace AQNWB::NWB