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"
#include "spec/hdmf_common.hpp"
 
namespace AQNWB::NWB
{
class VectorData : public Data
{
public:
  REGISTER_SUBCLASS(VectorData, Data, AQNWB::SPEC::HDMF_COMMON::namespaceName)
 
protected:
  VectorData(const std::string& path, std::shared_ptr<IO::BaseIO> io);
 
public:
  virtual ~VectorData() override {}

  static std::shared_ptr<VectorData> createReferenceVectorData(
      const std::string& path,
      std::shared_ptr<IO::BaseIO> io,
      const std::string& description,
      const std::vector<std::string>& references)
  {
    Status dataStatus = io->createReferenceDataSet(path, references);
    if (dataStatus != Status::Success) {
      return nullptr;
    }
 
    auto vectorData = VectorData::create(path, io);
    Status commonAttrsStatus = io->createCommonNWBAttributes(
        path, vectorData->getNamespace(), vectorData->getTypeName());
    Status attrStatus = io->createAttribute(description, path, "description");
    if ((attrStatus && commonAttrsStatus) != Status::Success) {
      return nullptr;
    }
 
    return vectorData;
  }

  Status initialize(const IO::BaseArrayDataSetConfig& dataConfig,
                    const std::string& description)
  {
    auto ioPtr = getIO();
    if (ioPtr == nullptr) {
      std::cerr << "IO object has been deleted. Can't initialize VectorData: "
                << m_path << std::endl;
      return Status::Failure;
    }
    Status dataStatus = Data::initialize(dataConfig);
    if (dataConfig.isLink()) {
      // For links, we don't set attributes since there is no dataset to attach
      // them to. Validate that the target has the required "description"
      // attribute.
      const auto* linkConfig =
          dynamic_cast<const IO::LinkArrayDataSetConfig*>(&dataConfig);
      if (linkConfig) {
        return dataStatus
            && linkConfig->validateTarget(*ioPtr, {}, {}, {"description"});
      }
      return dataStatus;
    } else {
      Status attrStatus =
          ioPtr->createAttribute(description, m_path, "description");
      return dataStatus && attrStatus;
    }
  }
 
  DEFINE_ATTRIBUTE_FIELD(readDescription,
                         std::string,
                         "description",
                         Description of what these vectors represent)
};

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

  virtual ~VectorDataTyped() override {}

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