AQNWB::IO Namespace Reference

The namespace for IO components of AqNWB. More...

Namespaces
namespace	HDF5
	Namespace for all components of the HDF5 I/O backend.

Classes
class	ArrayDataSetConfig
	The configuration for an array dataset. More...
class	BaseDataType
	Represents a base data type. More...
class	BaseIO
	The BaseIO class is an abstract base class that defines the interface for input/output (IO) operations on a file. More...
class	BaseRecordingData
	The base class to represent recording data that can be extended. More...
class	DataBlock
	Structure to hold data and shape for a typed data vector. More...
class	DataBlockGeneric
	Generic structure to hold type-erased data and shape. More...
struct	isAllowedStorageObjectType
struct	isAllowedStorageObjectType< StorageObjectType::Attribute >
struct	isAllowedStorageObjectType< StorageObjectType::Dataset >
class	ReadDataWrapper
	Class for wrapping data objects (datasets or attributes) for reading data from a file. More...

Enumerations
enum class	SearchMode { STOP_ON_TYPE = 1 , CONTINUE_ON_TYPE = 2 }
	Enum class for specifying the search mode for findTypes. More...
enum class	FileMode { Overwrite , ReadWrite , ReadOnly }
	The access mode for the file. More...

Detailed Description

The namespace for IO components of AqNWB.

Enumeration Type Documentation

FileMode

enum class AQNWB::IO::FileMode

strong

The access mode for the file.

Enumerator
Overwrite	Opens the file and overwrites any existing file.
ReadWrite	Opens the file with both read and write access. Note: This is similar to r+ mode, so the file will not be created if it does not exist.
ReadOnly	Opens the file in read only mode. Note: This is similar to r+ mode, so the file will not be created if it does not exist.

SearchMode

enum class AQNWB::IO::SearchMode

strong

Enum class for specifying the search mode for findTypes.

Enumerator
STOP_ON_TYPE	Stop searching inside an object once a matching type is found.
CONTINUE_ON_TYPE	Continue searching inside an object even after a matching type is found.