An n-dimensional dataset representing a column of a DynamicTable. More...

#include <VectorData.hpp>

Inheritance diagram for AQNWB::NWB::VectorData:

Collaboration diagram for AQNWB::NWB::VectorData:

Public Member Functions
	VectorData (const std::string &path, std::shared_ptr< IO::BaseIO > io)
	Constructor.

virtual	~VectorData () override
	Virtual destructor.

Status	initialize (std::unique_ptr< IO::BaseRecordingData > &&dataset, const std::string &description)
	Initialize the dataset for the VectorData object.

template<typename VTYPE = std::string>
std::unique_ptr< IO::ReadDataWrapper< AttributeField, VTYPE > >	readDescription () const

Public Member Functions inherited from AQNWB::NWB::Data
	Data (const std::string &path, std::shared_ptr< IO::BaseIO > io)
	Constructor.

virtual	~Data () override
	Virtual destructor.

Status	initialize (std::unique_ptr< IO::BaseRecordingData > &&dataset)
	Initialize the dataset for the Data object.

bool	isInitialized ()
	Check whether the m_dataset has been initialized.

template<typename VTYPE = std::any>
std::unique_ptr< IO::ReadDataWrapper< DatasetField, VTYPE > >	readData () const

template<typename VTYPE = std::string>
std::unique_ptr< IO::ReadDataWrapper< AttributeField, VTYPE > >	readNeurodataType () const

template<typename VTYPE = std::string>
std::unique_ptr< IO::ReadDataWrapper< AttributeField, VTYPE > >	readNamespace () const

Public Member Functions inherited from AQNWB::NWB::RegisteredType
	RegisteredType (const std::string &path, std::shared_ptr< IO::BaseIO > io)
	Constructor.

virtual	~RegisteredType ()
	Destructor.

std::string	getPath () const
	Gets the path of the registered type.

std::string	getName () const
	Get the name of the object.

std::shared_ptr< IO::BaseIO >	getIO () const
	Get a shared pointer to the IO object.

virtual std::string	getTypeName () const
	Get the name of the class type.

virtual std::string	getNamespace () const
	Get the schema namespace of the class type.

std::string	getFullTypeName () const
	Get the full name of the type, i.e., `namespace::typename`

template<StorageObjectType SOT, typename VTYPE, typename std::enable_if< Types::IsDataStorageObjectType< SOT >::value, int >::type = 0>
std::unique_ptr< IO::ReadDataWrapper< SOT, VTYPE > >	readField (const std::string &fieldPath) const
	Support reading of arbitrary fields by their relative path.

std::shared_ptr< AQNWB::NWB::RegisteredType >	readField (const std::string &fieldPath) const
	Read a field that is itself a RegisteredType.

virtual std::unordered_map< std::string, std::string >	findOwnedTypes (const std::unordered_set< std::string > &types={}, const IO::SearchMode &search_mode=IO::SearchMode::STOP_ON_TYPE) const
	Find all typed objects that are owned by this object, i.e., objects that have a neurodata_type and namespace attribute and have this object as there closest parent with an assigned type.

Additional Inherited Members
Static Public Member Functions inherited from AQNWB::NWB::RegisteredType
static std::unordered_set< std::string > &	getRegistry ()
	Get the registry of subclass names.

static std::unordered_map< std::string, std::pair< std::function< std::unique_ptr< RegisteredType >(const std::string &, std::shared_ptr< IO::BaseIO >)>, std::pair< std::string, std::string > > > &	getFactoryMap ()
	Get the factory map for creating instances of subclasses.

static std::shared_ptr< RegisteredType >	create (const std::string &fullClassName, const std::string &path, std::shared_ptr< IO::BaseIO > io, bool fallbackToBase=false)
	Create an instance of a registered subclass by name.

static std::shared_ptr< AQNWB::NWB::RegisteredType >	create (const std::string &path, std::shared_ptr< IO::BaseIO > io, bool fallbackToBase=false)
	Factory method to create an instance of a subclass of RegisteredType from file.

template<typename T>
static std::shared_ptr< T >	create (const std::string &path, std::shared_ptr< IO::BaseIO > io)
	Factory method to create an instance of a subclass of RegisteredType by type.

Public Attributes inherited from AQNWB::NWB::Data
std::unique_ptr< IO::BaseRecordingData >	m_dataset

Static Protected Member Functions inherited from AQNWB::NWB::RegisteredType
static void	registerSubclass (const std::string &fullClassName, std::function< std::unique_ptr< RegisteredType >(const std::string &, std::shared_ptr< IO::BaseIO >)> factoryFunction, const std::string &typeName, const std::string &typeNamespace)
	Register a subclass name and its factory function in the registry.

Protected Attributes inherited from AQNWB::NWB::RegisteredType
std::string	m_path
	The path of the registered type.

std::shared_ptr< IO::BaseIO >	m_io
	A shared pointer to the IO object.

Static Protected Attributes inherited from AQNWB::NWB::RegisteredType
static const std::string	m_defaultUnregisteredGroupTypeClass
	Save the default RegisteredType to use for reading Group types that are not registered.

static const std::string	m_defaultUnregisteredDatasetTypeClass
	Save the default RegisteredType to use for reading Dataset types that are not registered.

Detailed Description

An n-dimensional dataset representing a column of a DynamicTable.

Constructor & Destructor Documentation

◆ VectorData()

VectorData::VectorData	(	const std::string &	path,
		std::shared_ptr< IO::BaseIO >	io )

Constructor.

Parameters

path	The path of the container.
io	A shared pointer to the IO object.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~VectorData()

virtual AQNWB::NWB::VectorData::~VectorData ( )

inlineoverridevirtual

Virtual destructor.

Member Function Documentation

◆ initialize()

Status AQNWB::NWB::VectorData::initialize	(	std::unique_ptr< IO::BaseRecordingData > &&	dataset,
		const std::string &	description )

inline

Initialize the dataset for the VectorData object.

This functions takes ownership of the passed rvalue unique_ptr and moves ownership to its internal m_dataset variable

Parameters

dataset	The rvalue unique pointer to the BaseRecordingData object
description	The description of the VectorData

Returns: Status::Success if successful, otherwise Status::Failure.

Here is the call graph for this function:

◆ readDescription()

template<typename VTYPE = std::string>

std::unique_ptr< IO::ReadDataWrapper< AttributeField, VTYPE > > AQNWB::NWB::VectorData::readDescription ( ) const

inline

Description of what these vectors represent

The documentation for this class was generated from the following files:

src/nwb/hdmf/table/VectorData.hpp
src/nwb/hdmf/table/VectorData.cpp

Public Member Functions