Class DSetCreatPropList inherits from ObjCreatPropList and provides wrappers for the HDF5 dataset creation property functions. More...

#include <H5DcreatProp.h>

Inheritance diagram for H5::DSetCreatPropList:

Collaboration diagram for H5::DSetCreatPropList:

Public Member Functions
	DSetCreatPropList ()

bool	allFiltersAvail () const

H5D_alloc_time_t	getAllocTime () const

void	setAllocTime (H5D_alloc_time_t alloc_time) const

int	getChunk (int max_ndims, hsize_t *dim) const

void	setChunk (int ndims, const hsize_t *dim) const

void	getExternal (unsigned idx, size_t name_size, char *name, off_t &offset, hsize_t &size) const

int	getExternalCount () const

H5D_fill_time_t	getFillTime () const

void	setFillTime (H5D_fill_time_t fill_time) const

void	getFillValue (const DataType &fvalue_type, void *value) const

void	setFillValue (const DataType &fvalue_type, const void *value) const

H5Z_filter_t	getFilter (int filter_number, unsigned int &flags, size_t &cd_nelmts, unsigned int *cd_values, size_t namelen, char name[], unsigned int &filter_config) const

void	getFilterById (H5Z_filter_t filter_id, unsigned int &flags, size_t &cd_nelmts, unsigned int *cd_values, size_t namelen, char name[], unsigned int &filter_config) const

H5D_layout_t	getLayout () const

void	setLayout (H5D_layout_t layout) const

int	getNfilters () const

H5D_fill_value_t	isFillValueDefined () const

void	modifyFilter (H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[]) const

void	removeFilter (H5Z_filter_t filter_id) const

void	setDeflate (int level) const

void	setExternal (const char *name, off_t offset, hsize_t size) const

void	setFilter (H5Z_filter_t filter, unsigned int flags=0, size_t cd_nelmts=0, const unsigned int cd_values[]=NULL) const

void	setFletcher32 () const

void	setShuffle () const

void	setSzip (unsigned int options_mask, unsigned int pixels_per_block) const

void	setNbit () const

virtual H5std_string	fromClass () const
	Returns this class name. More...

	DSetCreatPropList (const DSetCreatPropList &orig)

	DSetCreatPropList (const hid_t plist_id)

virtual	~DSetCreatPropList ()

Public Member Functions inherited from H5::ObjCreatPropList
	ObjCreatPropList ()

void	setAttrPhaseChange (unsigned max_compact=8, unsigned min_dense=6) const

void	getAttrPhaseChange (unsigned &max_compact, unsigned &min_dense) const

void	setAttrCrtOrder (unsigned crt_order_flags) const

unsigned	getAttrCrtOrder () const

	ObjCreatPropList (const ObjCreatPropList &original)

	ObjCreatPropList (const hid_t plist_id)

virtual	~ObjCreatPropList ()

Public Member Functions inherited from H5::PropList
	PropList (const hid_t plist_id)

PropList &	operator= (const PropList &rhs)

bool	operator== (const PropList &rhs) const

virtual void	close ()

void	closeClass () const

void	copy (const PropList &like_plist)

void	copyProp (PropList &dest, const char *name) const

void	copyProp (PropList &dest, const H5std_string &name) const

void	copyProp (PropList &dest, PropList &src, const char *name) const

void	copyProp (PropList &dest, PropList &src, const H5std_string &name) const

hid_t	getClass () const

H5std_string	getClassName () const

PropList	getClassParent () const

size_t	getNumProps () const

void	getProperty (const char name, void value) const

void	getProperty (const H5std_string &name, void *value) const

H5std_string	getProperty (const char *name) const

H5std_string	getProperty (const H5std_string &name) const

void	setProperty (const char name, void value) const

void	setProperty (const char name, const char charptr) const

void	setProperty (const char *name, H5std_string &strg) const

void	setProperty (const H5std_string &name, void *value) const

void	setProperty (const H5std_string &name, H5std_string &strg) const

size_t	getPropSize (const char *name) const

size_t	getPropSize (const H5std_string &name) const

bool	isAClass (const PropList &prop_class) const

bool	propExist (const char *name) const
	Query the existance of a property in a property object. More...

bool	propExist (const H5std_string &name) const

void	removeProp (const char *name) const

void	removeProp (const H5std_string &name) const

	PropList ()

	PropList (const PropList &original)

virtual hid_t	getId () const

virtual	~PropList ()

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::ObjCreatPropList
static void	deleteConstants ()

Static Public Member Functions inherited from H5::PropList
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 DSetCreatPropList &	DEFAULT
	Default dataset creation property list. More...

Static Public Attributes inherited from H5::ObjCreatPropList
static const ObjCreatPropList &	DEFAULT
	Default object creation property list. More...

Static Public Attributes inherited from H5::PropList
static const PropList &	DEFAULT
	Default property list. More...

Static Private Member Functions
static DSetCreatPropList *	getConstant ()

Static Private Attributes
static DSetCreatPropList *	DEFAULT_

Additional Inherited Members
Protected Member Functions inherited from H5::PropList
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 Protected Member Functions inherited from H5::IdComponent
static bool	p_valid_id (const hid_t obj_id)

Protected Attributes inherited from H5::PropList
hid_t	id

Static Protected Attributes inherited from H5::IdComponent
static bool	H5dontAtexit_called

Detailed Description

Class DSetCreatPropList inherits from ObjCreatPropList and provides wrappers for the HDF5 dataset creation property functions.

Definition at line 28 of file H5DcreatProp.h.

Constructor & Destructor Documentation

◆ DSetCreatPropList() [1/3]

H5::DSetCreatPropList::DSetCreatPropList ( )

◆ DSetCreatPropList() [2/3]

H5::DSetCreatPropList::DSetCreatPropList ( const DSetCreatPropList & orig )

◆ DSetCreatPropList() [3/3]

H5::DSetCreatPropList::DSetCreatPropList ( const hid_t plist_id )

◆ ~DSetCreatPropList()

virtual H5::DSetCreatPropList::~DSetCreatPropList ( )

virtual

Member Function Documentation

◆ allFiltersAvail()

bool H5::DSetCreatPropList::allFiltersAvail ( ) const

◆ deleteConstants()

static void H5::DSetCreatPropList::deleteConstants ( )

static

◆ fromClass()

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

inlinevirtual

Returns this class name.

Reimplemented from H5::ObjCreatPropList.

Definition at line 118 of file H5DcreatProp.h.

◆ getAllocTime()

H5D_alloc_time_t H5::DSetCreatPropList::getAllocTime ( ) const

◆ getChunk()

int H5::DSetCreatPropList::getChunk	(	int	max_ndims,
		hsize_t *	dim
	)		const

◆ getConstant()

static DSetCreatPropList* H5::DSetCreatPropList::getConstant ( )

staticprivate

◆ getExternal()

void H5::DSetCreatPropList::getExternal	(	unsigned	idx,
		size_t	name_size,
		char *	name,
		off_t &	offset,
		hsize_t &	size
	)		const

◆ getExternalCount()

int H5::DSetCreatPropList::getExternalCount ( ) const

◆ getFillTime()

H5D_fill_time_t H5::DSetCreatPropList::getFillTime ( ) const

◆ getFillValue()

void H5::DSetCreatPropList::getFillValue	(	const DataType &	fvalue_type,
		void *	value
	)		const

◆ getFilter()

H5Z_filter_t H5::DSetCreatPropList::getFilter	(	int	filter_number,
		unsigned int &	flags,
		size_t &	cd_nelmts,
		unsigned int *	cd_values,
		size_t	namelen,
		char	name[],
		unsigned int &	filter_config
	)		const

◆ getFilterById()

void H5::DSetCreatPropList::getFilterById	(	H5Z_filter_t	filter_id,
		unsigned int &	flags,
		size_t &	cd_nelmts,
		unsigned int *	cd_values,
		size_t	namelen,
		char	name[],
		unsigned int &	filter_config
	)		const

◆ getLayout()

H5D_layout_t H5::DSetCreatPropList::getLayout ( ) const

◆ getNfilters()

int H5::DSetCreatPropList::getNfilters ( ) const

◆ isFillValueDefined()

H5D_fill_value_t H5::DSetCreatPropList::isFillValueDefined ( ) const

◆ modifyFilter()

void H5::DSetCreatPropList::modifyFilter	(	H5Z_filter_t	filter_id,
		unsigned int	flags,
		size_t	cd_nelmts,
		const unsigned int	cd_values[]
	)		const

◆ removeFilter()

void H5::DSetCreatPropList::removeFilter ( H5Z_filter_t filter_id ) const

◆ setAllocTime()

void H5::DSetCreatPropList::setAllocTime ( H5D_alloc_time_t alloc_time ) const

◆ setChunk()

void H5::DSetCreatPropList::setChunk	(	int	ndims,
		const hsize_t *	dim
	)		const

◆ setDeflate()

void H5::DSetCreatPropList::setDeflate ( int level ) const

◆ setExternal()

void H5::DSetCreatPropList::setExternal	(	const char *	name,
		off_t	offset,
		hsize_t	size
	)		const

◆ setFillTime()

void H5::DSetCreatPropList::setFillTime ( H5D_fill_time_t fill_time ) const

◆ setFillValue()

void H5::DSetCreatPropList::setFillValue	(	const DataType &	fvalue_type,
		const void *	value
	)		const

◆ setFilter()

void H5::DSetCreatPropList::setFilter	(	H5Z_filter_t	filter,
		unsigned int	flags = `0`,
		size_t	cd_nelmts = `0`,
		const unsigned int	cd_values[] = `NULL`
	)		const

◆ setFletcher32()

void H5::DSetCreatPropList::setFletcher32 ( ) const

◆ setLayout()

void H5::DSetCreatPropList::setLayout ( H5D_layout_t layout ) const

◆ setNbit()

void H5::DSetCreatPropList::setNbit ( ) const

◆ setShuffle()

void H5::DSetCreatPropList::setShuffle ( ) const

◆ setSzip()

void H5::DSetCreatPropList::setSzip	(	unsigned int	options_mask,
		unsigned int	pixels_per_block
	)		const

Field Documentation

◆ DEFAULT

const DSetCreatPropList& H5::DSetCreatPropList::DEFAULT