H5::DataSpace Class Reference

Class DataSpace inherits from IdComponent and provides wrappers for the HDF5's dataspaces. More...

#include <H5DataSpace.h>

Inheritance diagram for H5::DataSpace:

Collaboration diagram for H5::DataSpace:

Public Member Functions
	DataSpace (H5S_class_t type=H5S_SCALAR)
	DataSpace (int rank, const hsize_t *dims, const hsize_t *maxdims=NULL)
	DataSpace (const hid_t space_id)
	DataSpace (const DataSpace &original)
DataSpace &	operator= (const DataSpace &rhs)
virtual void	close ()
void	copy (const DataSpace &like_space)
void	extentCopy (const DataSpace &dest_space) const
void	getSelectBounds (hsize_t *start, hsize_t *end) const
hssize_t	getSelectElemNpoints () const
void	getSelectElemPointlist (hsize_t startpoint, hsize_t numpoints, hsize_t *buf) const
void	getSelectHyperBlocklist (hsize_t startblock, hsize_t numblocks, hsize_t *buf) const
hssize_t	getSelectHyperNblocks () const
hssize_t	getSelectNpoints () const
int	getSimpleExtentDims (hsize_t *dims, hsize_t *maxdims=NULL) const
int	getSimpleExtentNdims () const
hssize_t	getSimpleExtentNpoints () const
H5S_class_t	getSimpleExtentType () const
bool	isSimple () const
void	offsetSimple (const hssize_t *offset) const
void	selectAll () const
void	selectElements (H5S_seloper_t op, const size_t num_elements, const hsize_t *coord) const
void	selectHyperslab (H5S_seloper_t op, const hsize_t *count, const hsize_t *start, const hsize_t *stride=NULL, const hsize_t *block=NULL) const
void	selectNone () const
bool	selectValid () const
void	setExtentNone () const
void	setExtentSimple (int rank, const hsize_t *current_size, const hsize_t *maximum_size=NULL) const
virtual H5std_string	fromClass () const
	Returns this class name. More...
virtual hid_t	getId () const
virtual	~DataSpace ()
Public Member Functions inherited from H5::IdComponent
void	incRefCount (const hid_t obj_id) const
void	incRefCount () const
void	decRefCount (const hid_t obj_id) const
void	decRefCount () const
int	getCounter (const hid_t obj_id) const
int	getCounter () const
H5I_type_t	getHDFObjType () const
IdComponent &	operator= (const IdComponent &rhs)
void	setId (const hid_t new_id)
virtual void	throwException (const H5std_string &func_name, const H5std_string &msg) const
H5std_string	inMemFunc (const char *func_name) const
virtual	~IdComponent ()

Static Public Member Functions
static void	deleteConstants ()
Static Public Member Functions inherited from H5::IdComponent
static H5I_type_t	getHDFObjType (const hid_t obj_id)
static bool	isValid (hid_t an_id)

Static Public Attributes
static const DataSpace &	ALL
	Default DataSpace objects. More...

Protected Member Functions
virtual void	p_setId (const hid_t new_id)
Protected Member Functions inherited from H5::IdComponent
	IdComponent ()
H5std_string	p_get_file_name () const

Static Private Member Functions
static DataSpace *	getConstant ()

Private Attributes
hid_t	id

Static Private Attributes
static DataSpace *	ALL_

Friends
void	f_DataSpace_setId (DataSpace *dspace, hid_t new_id)

Additional Inherited Members
Static Protected Member Functions inherited from H5::IdComponent
static bool	p_valid_id (const hid_t obj_id)
Static Protected Attributes inherited from H5::IdComponent
static bool	H5dontAtexit_called

Detailed Description

Class DataSpace inherits from IdComponent and provides wrappers for the HDF5's dataspaces.

Definition at line 25 of file H5DataSpace.h.

Constructor & Destructor Documentation

DataSpace() [1/4]

H5::DataSpace::DataSpace

(

H5S_class_t

type = H5S_SCALAR

)

DataSpace() [2/4]

H5::DataSpace::DataSpace	(	int	rank,
		const hsize_t *	dims,
		const hsize_t *	maxdims = NULL
	)

DataSpace() [3/4]

H5::DataSpace::DataSpace

(

const hid_t

space_id

)

DataSpace() [4/4]

H5::DataSpace::DataSpace

(

const DataSpace &

original

)

~DataSpace()

virtual H5::DataSpace::~DataSpace ( )

virtual

Member Function Documentation

close()

virtual void H5::DataSpace::close ( )

virtual

Implements H5::IdComponent.

copy()

void H5::DataSpace::copy

(

const DataSpace &

like_space

)

deleteConstants()

static void H5::DataSpace::deleteConstants ( )

static

extentCopy()

void H5::DataSpace::extentCopy

(

const DataSpace &

dest_space

)

const

fromClass()

virtual H5std_string H5::DataSpace::fromClass ( ) const

inlinevirtual

Returns this class name.

Reimplemented from H5::IdComponent.

Definition at line 116 of file H5DataSpace.h.

getConstant()

static DataSpace* H5::DataSpace::getConstant ( )

staticprivate

getId()

virtual hid_t H5::DataSpace::getId ( ) const

virtual

Implements H5::IdComponent.

getSelectBounds()

void H5::DataSpace::getSelectBounds	(	hsize_t *	start,
		hsize_t *	end
	)		const

getSelectElemNpoints()

hssize_t H5::DataSpace::getSelectElemNpoints

(

)

const

getSelectElemPointlist()

void H5::DataSpace::getSelectElemPointlist	(	hsize_t	startpoint,
		hsize_t	numpoints,
		hsize_t *	buf
	)		const

getSelectHyperBlocklist()

void H5::DataSpace::getSelectHyperBlocklist	(	hsize_t	startblock,
		hsize_t	numblocks,
		hsize_t *	buf
	)		const

getSelectHyperNblocks()

hssize_t H5::DataSpace::getSelectHyperNblocks

(

)

const

getSelectNpoints()

hssize_t H5::DataSpace::getSelectNpoints

(

)

const

getSimpleExtentDims()

int H5::DataSpace::getSimpleExtentDims	(	hsize_t *	dims,
		hsize_t *	maxdims = NULL
	)		const

getSimpleExtentNdims()

int H5::DataSpace::getSimpleExtentNdims

(

)

const

getSimpleExtentNpoints()

hssize_t H5::DataSpace::getSimpleExtentNpoints

(

)

const

getSimpleExtentType()

H5S_class_t H5::DataSpace::getSimpleExtentType

(

)

const

isSimple()

bool H5::DataSpace::isSimple

(

)

const

offsetSimple()

void H5::DataSpace::offsetSimple

(

const hssize_t *

offset

)

const

operator=()

DataSpace& H5::DataSpace::operator=

(

const DataSpace &

rhs

)

p_setId()

virtual void H5::DataSpace::p_setId ( const hid_t  new_id )

protectedvirtual

Implements H5::IdComponent.

selectAll()

void H5::DataSpace::selectAll

(

)

const

selectElements()

void H5::DataSpace::selectElements	(	H5S_seloper_t	op,
		const size_t	num_elements,
		const hsize_t *	coord
	)		const

selectHyperslab()

void H5::DataSpace::selectHyperslab	(	H5S_seloper_t	op,
		const hsize_t *	count,
		const hsize_t *	start,
		const hsize_t *	stride = NULL,
		const hsize_t *	block = NULL
	)		const

selectNone()

void H5::DataSpace::selectNone

(

)

const

selectValid()

bool H5::DataSpace::selectValid

(

)

const

setExtentNone()

void H5::DataSpace::setExtentNone

(

)

const

setExtentSimple()

void H5::DataSpace::setExtentSimple	(	int	rank,
		const hsize_t *	current_size,
		const hsize_t *	maximum_size = NULL
	)		const

Friends And Related Function Documentation

f_DataSpace_setId

void f_DataSpace_setId ( DataSpace *  dspace, hid_t  new_id  )

friend

Field Documentation

ALL

const DataSpace& H5::DataSpace::ALL

static

Default DataSpace objects.

Definition at line 28 of file H5DataSpace.h.

ALL_

DataSpace* H5::DataSpace::ALL_

staticprivate

Definition at line 140 of file H5DataSpace.h.

id

hid_t H5::DataSpace::id

private

Definition at line 136 of file H5DataSpace.h.

---

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

• win64/HDF5_1.8.21/include/H5DataSpace.h