Class DSetAccPropList inherits from LinkAccPropList and provides wrappers for the HDF5 dataset access property functions.

#include <H5DaccProp.h>

Inheritance diagram for H5::DSetAccPropList:

Public Member Functions
	DSetAccPropList ()
	Default constructor: creates a stub dataset creation property list. More...

void	setChunkCache (size_t rdcc_nslots, size_t rdcc_nbytes, double rdcc_w0) const
	Sets the raw data chunk cache parameters. More...

void	getChunkCache (size_t &rdcc_nslots, size_t &rdcc_nbytes, double &rdcc_w0) const
	Retrieves the raw data chunk cache parameters. More...

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

	DSetAccPropList (const DSetAccPropList &orig)
	Copy constructor: same HDF5 object as original DSetAccPropList object. More...

	DSetAccPropList (const hid_t plist_id)
	Creates a DSetAccPropList object using the id of an existing dataset creation property list. More...

virtual	~DSetAccPropList ()
	Noop destructor. More...

Public Member Functions inherited from H5::LinkAccPropList
	LinkAccPropList ()
	Creates a file access property list. More...

	LinkAccPropList (const LinkAccPropList &original)
	Copy Constructor: same HDF5 object as original. More...

	LinkAccPropList (const hid_t plist_id)
	Creates a file access property list using the id of an existing one. More...

void	setNumLinks (size_t nlinks) const
	Set the number of soft or user-defined link traversals allowed before the library assumes it has found a cycle and aborts the traversal. More...

size_t	getNumLinks () const
	Gets the number of soft or user-defined links that can be traversed before a failure occurs. More...

virtual	~LinkAccPropList ()
	Noop destructor. More...

Public Member Functions inherited from H5::PropList
	PropList (const hid_t plist_id)
	Creates a property list using the id of an existing property. More...

PropList &	operator= (const PropList &rhs)
	Assignment operator. More...

bool	operator== (const PropList &rhs) const
	Compares this property list or class against the given list or class. More...

virtual void	close ()
	Closes the property list if it is not a default one. More...

void	closeClass () const
	Close a property list class. More...

void	copy (const PropList &like_plist)
	Makes a copy of an existing property list. More...

void	copyProp (PropList &dest, const char *name) const
	Copies a property from this property list or class to another. More...

void	copyProp (PropList &dest, const H5std_string &name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

void	copyProp (PropList &dest, PropList &src, const char *name) const
	Copies a property from one list or class to another - Obsolete. More...

void	copyProp (PropList &dest, PropList &src, const H5std_string &name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. - Obsolete. More...

hid_t	getClass () const
	Returns the class of this property list, i.e. `H5P_FILE_CREATE`... More...

H5std_string	getClassName () const
	Return the name of a generic property list class. More...

PropList	getClassParent () const
	Returns the parent class of a generic property class. More...

size_t	getNumProps () const
	Returns the number of properties in this property list or class. More...

void	getProperty (const char name, void value) const
	Query the value of a property in a property list. More...

void	getProperty (const H5std_string &name, void *value) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

H5std_string	getProperty (const char *name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

H5std_string	getProperty (const H5std_string &name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

void	setProperty (const char name, const char charptr) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

void	setProperty (const char name, const void value) const
	Set a property's value in a property list. More...

void	setProperty (const char *name, const H5std_string &strg) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

void	setProperty (const H5std_string &name, const void *value) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

void	setProperty (const H5std_string &name, const H5std_string &strg) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

void	setProperty (const char name, void value) const
	Deprecated due to missing const in prototype. (1.10.1) More...

void	setProperty (const char *name, H5std_string &strg) const
	Deprecated due to missing const in prototype. (1.10.1) More...

void	setProperty (const H5std_string &name, void *value) const
	Deprecated due to missing const in prototype. (1.10.1) More...

void	setProperty (const H5std_string &name, H5std_string &strg) const
	Deprecated due to missing const in prototype. (1.10.1) More...

size_t	getPropSize (const char *name) const
	Query the size of a property in a property list or class. More...

size_t	getPropSize (const H5std_string &name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

bool	isAClass (const PropList &prop_class) const
	Determines whether a property list is a certain class. More...

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

bool	propExist (const H5std_string &name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

void	removeProp (const char *name) const
	Removes a property from a property list. More...

void	removeProp (const H5std_string &name) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More...

	PropList ()
	Default constructor: creates a stub property list object. More...

	PropList (const PropList &original)
	Copy constructor: same HDF5 object as original. More...

virtual hid_t	getId () const
	Get the id of this property list. More...

virtual	~PropList ()
	Properly terminates access to this property list. More...

Public Member Functions inherited from H5::IdComponent
void	incRefCount (const hid_t obj_id) const
	Increment reference counter for a given id. More...

void	incRefCount () const
	Increment reference counter for the id of this object. More...

void	decRefCount (const hid_t obj_id) const
	Decrement reference counter for a given id. More...

void	decRefCount () const
	Decrement reference counter for the id of this object. More...

int	getCounter (const hid_t obj_id) const
	Returns the reference counter for a given id. More...

int	getCounter () const
	Returns the reference counter for the id of this object. More...

H5I_type_t	getHDFObjType () const
	Returns the type of the object. It is an overloaded function of the above function. More...

IdComponent &	operator= (const IdComponent &rhs)
	Assignment operator. More...

void	setId (const hid_t new_id)
	Sets the identifier of this object to a new value. More...

virtual	~IdComponent ()
	Noop destructor. More...

Static Public Attributes
static const DSetAccPropList &	DEFAULT
	Default dataset creation property list. More...

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

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

Additional Inherited Members
Static Public Member Functions inherited from H5::IdComponent
static H5I_type_t	getHDFObjType (const hid_t obj_id)
	Given an id, returns the type of the object. More...

static hsize_t	getNumMembers (H5I_type_t type)
	Returns the number of members of the given type. More...

static bool	isValid (hid_t an_id)
	Checks if the given ID is valid. More...

static bool	typeExists (H5I_type_t type)
	Queries if a given type is currently registered with the library. More...

Constructor & Destructor Documentation

H5::DSetAccPropList::DSetAccPropList ( )

H5::DSetAccPropList::DSetAccPropList ( const DSetAccPropList & orig )

H5::DSetAccPropList::DSetAccPropList ( const hid_t plist_id )

H5::DSetAccPropList::~DSetAccPropList ( )

virtual

Member Function Documentation

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

inlinevirtual

Reimplemented from H5::LinkAccPropList.

void H5::DSetAccPropList::getChunkCache	(	size_t &	rdcc_nslots,
		size_t &	rdcc_nbytes,
		double &	rdcc_w0
	)		const

Parameters

rdcc_nslots	- OUT: Number of chunk slots in the raw data chunk cache
rdcc_nbytes	- OUT: Total size of the raw data chunk cache
rdcc_w0	- OUT: The chunk preemption policy for this dataset

Exceptions

H5::PropListIException

Description: For information, please refer to the H5Pget_chunk_cache API in the HDF5 C Reference Manual.

void H5::DSetAccPropList::setChunkCache	(	size_t	rdcc_nslots,
		size_t	rdcc_nbytes,
		double	rdcc_w0
	)		const

Parameters

rdcc_nslots	- IN: Number of chunk slots in the raw data chunk cache
rdcc_nbytes	- IN: Total size of the raw data chunk cache
rdcc_w0	- IN: The chunk preemption policy for this dataset

Exceptions

H5::PropListIException

Description: The raw data chunk cache parameters includes the number of objects in the meta data cache and the maximum number of chunks and bytes in the raw data chunk cache. Once set, these values will override the values in the file access property list.

For information, please refer to the H5Pset_chunk_cache API in the HDF5 C Reference Manual.

Member Data Documentation

const DSetAccPropList& H5::DSetAccPropList::DEFAULT

static

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

H5DaccProp.h
H5DaccProp.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation