DynamicTable.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/hdmf/base/Container.hpp"
#include "nwb/hdmf/table/ElementIdentifiers.hpp"
#include "nwb/hdmf/table/VectorData.hpp"
 
namespace AQNWB::NWB
{
class DynamicTable : public Container
{
public:
  // Register the TimeSeries as a subclass of Container
  REGISTER_SUBCLASS(DynamicTable, "hdmf-common")
 
  
  DynamicTable(
      const std::string& path,
      std::shared_ptr<IO::BaseIO> io,
      const std::vector<std::string>& colNames =
          {});  // TODO Need to remove colNames here and move it to initialize

  virtual ~DynamicTable();

  void initialize(const std::string& description);

  void addColumn(std::unique_ptr<VectorData>& vectorData,
                 const std::vector<std::string>& values);

  void addReferenceColumn(const std::string& name,
                          const std::string& colDescription,
                          const std::vector<std::string>& dataset);

  void setRowIDs(std::unique_ptr<ElementIdentifiers>& elementIDs,
                 const std::vector<int>& values);

  virtual void setColNames(const std::vector<std::string>& newColNames)
  {
    m_colNames = newColNames;
  }
 
  DEFINE_FIELD(readColNames,
               AttributeField,
               std::string,
               "colnames",
               The names of the columns in the table)
 
  DEFINE_FIELD(readDescription,
               AttributeField,
               std::string,
               "description",
               Description of what is in this dynamic table)
 
  DEFINE_FIELD(readId,
               DatasetField, 
               std::any, 
               "id", 
               Array of unique identifiers for the rows of this dynamic table)
 
protected:
  std::vector<std::string> m_colNames;
};
}  // namespace AQNWB::NWB