hdf5::dataspace::Simple Class Reference

simple multidimensional dataspace

#include <simple.hpp>

Inheritance diagram for hdf5::dataspace::Simple:

Collaboration diagram for hdf5::dataspace::Simple:

Public Member Functions
	Simple ()
	default constructor
	Simple (const Dataspace &space)
	constructor
	Simple (const Dimensions &current, const Dimensions &maximum=hdf5::Dimensions())
	constructor
size_t	rank () const
	get number of dimensions
void	dimensions (const Dimensions &current, const Dimensions &maximum=Dimensions())
	set number of elements along each dimension
Dimensions	current_dimensions () const
	get current dimensions
Dimensions	maximum_dimensions () const
	get maximum dimensions
Public Member Functions inherited from hdf5::dataspace::Dataspace
virtual	~Dataspace ()
	destructor
	Dataspace ()
	default constructor
	Dataspace (ObjectHandle &&handle)
	constructor
	Dataspace (Dataspace &&type)=default
	move constructor
	Dataspace (const Dataspace &space)
	copy constructor
Dataspace &	operator= (const Dataspace &space)
	copy assignment
virtual hssize_t	size () const
	number of elements in the dataspace
	operator hid_t () const
	allows explicit conversion to hid_t
Type	type () const
	get the type of the dataspace
bool	is_valid () const
	check validity of the dataspace

Static Public Attributes
static const hsize_t	unlimited
	dimension value for unlimited number of elements

Additional Inherited Members
Public Attributes inherited from hdf5::dataspace::Dataspace
SelectionManager	selection
	access to selection manager
Protected Member Functions inherited from hdf5::dataspace::Dataspace
	Dataspace (Type type)

Constructor & Destructor Documentation

Simple() [1/3]

hdf5::dataspace::Simple::Simple

(

)

Simple() [2/3]

hdf5::dataspace::Simple::Simple

(

const Dataspace &

space

)

Construct a simple dataspace from a reference to its base instance. If space does not refer to a simple dataspace an exception will be thrown.

Exceptions

std::runtime_error

in case of a failure

Parameters

space

reference to a dataspace instance

Simple() [3/3]

hdf5::dataspace::Simple::Simple	(	const Dimensions &	current,
		const Dimensions &	maximum = hdf5::Dimensions()
	)

If the maximum dimensions is not provided it will be set to the current number of elements along each dimension.

Exceptions

std::runtime_error

in case of a failure

Parameters

current	current number of elements along each dimension
maximum	maximum number of elements along each dimension

See also

dimensions

Member Function Documentation

current_dimensions()

Dimensions hdf5::dataspace::Simple::current_dimensions

(

)

const

Exceptions

std::runtime_error

in case of a failure

dimensions()

void hdf5::dataspace::Simple::dimensions	(	const Dimensions &	current,
		const Dimensions &	maximum = Dimensions()
	)

Exceptions

std::runtime_error

in case of a failure

maximum_dimensions()

Dimensions hdf5::dataspace::Simple::maximum_dimensions

(

)

const

Exceptions

std::runtime_error

in case of a failure

rank()

size_t hdf5::dataspace::Simple::rank

(

)

const

Exceptions

std::runtime_error

in case of a failure

Member Data Documentation

unlimited

const hsize_t hdf5::dataspace::Simple::unlimited

static

---

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

• /home/p00user/src/src/h5cpp/dataspace/simple.hpp