CNORXZ::hdf5::SDataset< T > Class Template Reference

#include <h5_dataset.h>

Inheritance diagram for CNORXZ::hdf5::SDataset< T >:

Public Member Functions
	DEFAULT_MEMBERS (SDataset)
	SDataset (const String &name, const ContentBase *_parent)
MArray< T >	read () const
template<class I , typename M >
MArray< T >	read (const IndexInterface< I, M > &beg, const IndexInterface< I, M > &end) const
Public Member Functions inherited from CNORXZ::hdf5::Dataset
	DEFAULT_MEMBERS (Dataset)
	Dataset (const String &name, const ContentBase *_parent)
	~Dataset ()
virtual ContentType	type () const override final
virtual bool	ro () const override final
virtual Dataset &	open () override final
virtual Dataset &	close () override final
virtual String	path () const override final
virtual String	filename () const override final
virtual bool	exists () const override final
Dataset &	init (const RangePtr &dataRange, hid_t type)
template<typename T >
Dataset &	init (const ArrayBase< T > &data)
const RangePtr &	dataRange () const
Public Member Functions inherited from CNORXZ::hdf5::ContentBase
	DEFAULT_MEMBERS (ContentBase)
	ContentBase (const String &_name, const ContentBase *_parent=nullptr)
virtual	~ContentBase ()=default
const String &	name () const
const ContentBase *	parent () const
hid_t	id () const
bool	isOpen () const
template<typename T >
ContentBase &	addAttribute (const String &name, const T &value)
DType	getAttribute (const String &name) const
bool	attributeExists (const String &name) const
std::map< String, DType >	getAttributes () const
std::map< String, DType >	getRecursiveAttributes () const

Additional Inherited Members
Protected Attributes inherited from CNORXZ::hdf5::Dataset
RangePtr	mDataRange
hid_t	mType
hid_t	mFilespace
Protected Attributes inherited from CNORXZ::hdf5::ContentBase
String	mName
const ContentBase *	mParent = nullptr
hid_t	mId = 0

Detailed Description

template<typename T>
class CNORXZ::hdf5::SDataset< T >

---

Class to handle hdf5 datasets, the value type is known at compile time.

Template Parameters

T	Dataset value type.

Definition at line 76 of file h5_dataset.h.

Constructor & Destructor Documentation

SDataset()

template<typename T >

CNORXZ::hdf5::SDataset< T >::SDataset	(	const String &	name,
		const ContentBase *	_parent )

Construct the class.

Parameters

name	Dataset name.
_parent	Parent content object.

Definition at line 43 of file h5_dataset.cc.h.

Member Function Documentation

DEFAULT_MEMBERS()

template<typename T >

CNORXZ::hdf5::SDataset< T >::DEFAULT_MEMBERS

(

SDataset< T >

)

Default constructors and assignments.

read() [1/2]

template<typename T >

MArray< T > CNORXZ::hdf5::SDataset< T >::read

(

)

const

Read the dataset.

Returns

Array containing the dataset values.

Definition at line 48 of file h5_dataset.cc.h.

read() [2/2]

template<typename T >

template<class I , typename M >

MArray< T > CNORXZ::hdf5::SDataset< T >::read	(	const IndexInterface< I, M > &	beg,
		const IndexInterface< I, M > &	end ) const

Read a given subset of the dataset. The subset needs to be hypercubic.

Parameters

beg	Index indicating the begin edge of the hypercube.
end	Index indicating the end edge of the hypercube (inclusive).

Returns

Array containing the dataset values.

Definition at line 68 of file h5_dataset.cc.h.

---

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

• /github/workspace/src/opt/hdf5/include/h5_dataset.h
• /github/workspace/src/opt/hdf5/include/h5_dataset.cc.h