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"
 
namespace AQNWB::NWB
{
class AnnotationSeries : public TimeSeries
{
public:
  // Register the AnnotationSeries
  REGISTER_SUBCLASS(AnnotationSeries, "core")
 
  
  AnnotationSeries(const std::string& path, std::shared_ptr<IO::BaseIO> io);

  ~AnnotationSeries();

  void initialize(const std::string& description,
                  const std::string& comments,
                  const SizeArray& dsetSize,
                  const SizeArray& chunkSize);

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