TimeIntervals.hpp

Go to the documentation of this file.

#pragma once
 
// Common STL includes
#include <memory>
#include <optional>
#include <string>
#include <vector>
// Base AqNWB includes for IO and RegisteredType
#include "io/BaseIO.hpp"
#include "io/ReadIO.hpp"
#include "nwb/RegisteredType.hpp"
// Include for parent type
#include "nwb/hdmf/table/DynamicTable.hpp"
// Includes for types that are referenced and used
#include "nwb/hdmf/table/ElementIdentifiers.hpp"
#include "nwb/hdmf/table/VectorData.hpp"
#include "nwb/hdmf/table/VectorIndex.hpp"
// #include "core/base/TimeSeriesReferenceVectorData.hpp"
 
#include "spec/core.hpp"
 
namespace AQNWB::NWB
{

class TimeIntervals : public AQNWB::NWB::DynamicTable
{
protected:
  TimeIntervals(const std::string& path, std::shared_ptr<AQNWB::IO::BaseIO> io);
 
public:
  virtual ~TimeIntervals() override {}

  Status validateDataSpecs(
      const std::vector<DataSpecPtr>& dataSpecs) const override;

  static std::vector<DataSpecPtr> createDefaultDataSpecs(
      const std::string& timeIntervalsPath,
      const SizeType rowChunkSize = 100,
      const bool addTagsColumn = false);

  Status initialize(const std::string& description,
                    const std::vector<DataSpecPtr>& columnSpecs = {});
 
  // Define read methods
  DEFINE_REGISTERED_FIELD(readStartTime,
                          VectorDataTyped<float>,
                          "start_time",
                          "Start time of epoch - in seconds.")
 
  DEFINE_REGISTERED_FIELD(readStopTime,
                          VectorDataTyped<float>,
                          "stop_time",
                          "Stop time of epoch - in seconds.")
 
  DEFINE_REGISTERED_FIELD(
      readTags,
      VectorDataTyped<std::string>,
      "tags",
      "User-defined tags that identify or categorize events.")
 
  DEFINE_REGISTERED_FIELD(readTagsIndex,
                          VectorIndex,
                          "tags_index",
                          "Index for tags.")
 
  /*
  // TODO Add support for the timeseries columns requires support for
  TimeSeriesReferenceVectorData DEFINE_REGISTERED_FIELD( readTimeseries,
      CORE::TimeSeriesReferenceVectorData,
      "timeseries",
      "An index into a TimeSeries object.")
  */
  /*
  // TODO Add support for timeseries_index requires support for VectorIndex
  DEFINE_REGISTERED_FIELD(
      readTimeseriesIndex,
      HDMF_COMMON::VectorIndex,
      "timeseries_index",
      "Index for timeseries.")
  */
 
  REGISTER_SUBCLASS(TimeIntervals,
                    DynamicTable,
                    AQNWB::SPEC::CORE::namespaceName)
};
 
}  // namespace AQNWB::NWB