AnnotationSeries.hpp

Go to the documentation of this file.

#pragma once
 
#include <string>
 
#include "Utils.hpp"
#include "io/BaseIO.hpp"
#include "io/ReadIO.hpp"
#include "nwb/base/TimeSeries.hpp"
#include "spec/core.hpp"
 
namespace AQNWB::NWB
{
class AnnotationSeries : public TimeSeries
{
public:
  // Register the AnnotationSeries
  REGISTER_SUBCLASS(AnnotationSeries,
                    TimeSeries,
                    AQNWB::SPEC::CORE::namespaceName)
 
protected:
  AnnotationSeries(const std::string& path, std::shared_ptr<IO::BaseIO> io);
 
public:
  ~AnnotationSeries();

  Status initialize(const std::string& description,
                    const std::string& comments,
                    const IO::ArrayDataSetConfig& dataConfig);

  Status writeAnnotation(const SizeType& numSamples,
                         const std::vector<std::string> dataInput,
                         const void* timestampsInput,
                         const void* controlInput = nullptr);
 
  DEFINE_DATASET_FIELD(readData,
                       recordData,
                       std::string,
                       "data",
                       Annotations made during an experiment.)
 
private:
  SizeType m_samplesRecorded = 0;
};
}  // namespace AQNWB::NWB