VectorData.hpp

Go to the documentation of this file.

#pragma once
 
#include <string>
 
#include "Utils.hpp"
#include "io/ReadIO.hpp"
#include "nwb/hdmf/base/Data.hpp"
 
namespace AQNWB::NWB
{
class VectorData : public Data
{
public:
  REGISTER_SUBCLASS(VectorData, "hdmf-common")
 
  
  VectorData(const std::string& path, std::shared_ptr<IO::BaseIO> io);

  virtual ~VectorData() override {}

  Status initialize(std::unique_ptr<IO::BaseRecordingData>&& dataset,
                    const std::string& description)
  {
    Status dataStatus = Data::initialize(std::move(dataset));
    Status attrStatus =
        m_io->createAttribute(description, m_path, "description");
    return dataStatus && attrStatus;
  }
 
  DEFINE_FIELD(readDescription,
               AttributeField,
               std::string,
               "description",
               Description of what these vectors represent)
};

template<typename DTYPE = std::any>
class VectorDataTyped : public VectorData
{
public:
  VectorDataTyped(const std::string& path, std::shared_ptr<IO::BaseIO> io)
      : VectorData(path, io)
  {
  }

  virtual ~VectorDataTyped() override {}

  static std::shared_ptr<VectorDataTyped<DTYPE>> fromVectorData(
      const VectorData& data)
  {
    return std::make_shared<VectorDataTyped<DTYPE>>(data.getPath(),
                                                    data.getIO());
  }
 
  using RegisteredType::m_io;
  using RegisteredType::m_path;
 
  // Define the data fields to expose for lazy read access
  DEFINE_FIELD(readData, DatasetField, DTYPE, "", The main data)
};
}  // namespace AQNWB::NWB