MeaningsTable.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"
// Forward declarations for referenced types
namespace AQNWB::NWB
{
class ElementIdentifiers;
class VectorData;
}  // namespace AQNWB::NWB
// Include for the namespace schema header
#include "spec/hdmf_common.hpp"
 
namespace AQNWB::NWB
{

class MeaningsTable : public AQNWB::NWB::DynamicTable
{
public:
  virtual ~MeaningsTable() override {}

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

  static std::vector<DataSpecPtr> createDefaultDataSpecs(
      const AQNWB::IO::BaseDataType& valueDataType,
      const SizeType rowChunkSize = 100);

  Status initialize(const VectorData& targetVectorData,
                    const AQNWB::IO::BaseDataType& valueDataType,
                    const std::string& description =
                        "A table to store information about the meanings of "
                        "values in a referenced VectorData object.",
                    const std::vector<DataSpecPtr>& columnSpecs = {});
 
  DEFINE_REGISTERED_FIELD(
      readValueColumn,
      AQNWB::NWB::VectorData,
      "value",
      "The value of a row in the referenced VectorData object.")
 
  DEFINE_REGISTERED_FIELD(
      readMeaningColumn,
      AQNWB::NWB::VectorDataTyped<std::string>,
      "meaning",
      "The meaning of the value in the referenced VectorData object.")
 
  DEFINE_REFERENCED_REGISTERED_FIELD(readTarget,
                                     AQNWB::NWB::VectorData,
                                     "target",
                                     "Reference to the VectorData object for "
                                     "which this table provides meanings.")
 
  REGISTER_SUBCLASS(MeaningsTable,
                    DynamicTable,
                    AQNWB::SPEC::HDMF_COMMON::namespaceName)
 
protected:
  MeaningsTable(const std::string& path, std::shared_ptr<AQNWB::IO::BaseIO> io);
};
 
}  // namespace AQNWB::NWB