H5::DSetMemXferPropList Class Reference

Class DSetCreatPropList inherits from PropList and provides wrappers for the HDF5 dataset memory and transfer property list.

#include <H5DxferProp.h>

Inheritance diagram for H5::DSetMemXferPropList:

Public Member Functions
	DSetMemXferPropList ()
	Default constructor: creates a stub dataset memory and transfer property list object. More...
	DSetMemXferPropList (const char *expression)
	Creates a dataset transfer property list with transform expression. More...
void	setBuffer (size_t size, void *tconv, void *bkg) const
	Sets type conversion and background buffers. More...
size_t	getBuffer (void **tconv, void **bkg) const
	Reads buffer settings. More...
void	setBtreeRatios (double left, double middle, double right) const
	Sets B-tree split ratios for a dataset transfer property list. More...
void	getBtreeRatios (double &left, double &middle, double &right) const
	Gets B-tree split ratios for a dataset transfer property list. More...
void	setDataTransform (const char *expression) const
	Sets data transform expression. More...
void	setDataTransform (const H5std_string &expression) const
	This is an overloaded member function, provided for convenience. It takes a reference to a H5std_string for the expression. More...
ssize_t	getDataTransform (char *exp, size_t buf_size=0) const
	Sets data transform expression. More...
H5std_string	getDataTransform () const
	This is an overloaded member function, provided for convenience. It takes no parameter and returns a H5std_string for the expression. Exceptions H5::PropListIException. More...
void	setPreserve (bool status) const
	Sets the dataset transfer property list status to true or false. More...
bool	getPreserve () const
	Checks status of the dataset transfer property list. More...
void	setTypeConvCB (H5T_conv_except_func_t op, void *user_data) const
	Sets an exception handling callback for datatype conversion for a dataset transfer property list. More...
void	getTypeConvCB (H5T_conv_except_func_t *op, void **user_data) const
	Gets the exception handling callback function and data. More...
void	setVlenMemManager (H5MM_allocate_t alloc, void *alloc_info, H5MM_free_t free, void *free_info) const
	Sets the memory manager for variable-length datatype allocation. More...
void	setVlenMemManager () const
	Sets the memory manager for variable-length datatype allocation - system malloc and free will be used. More...
void	getVlenMemManager (H5MM_allocate_t &alloc, void **alloc_info, H5MM_free_t &free, void **free_info) const
	Gets the memory manager for variable-length datatype allocation. More...
void	setSmallDataBlockSize (hsize_t size) const
	Sets the size of a contiguous block reserved for small data. More...
hsize_t	getSmallDataBlockSize () const
	Returns the current small data block size setting. More...
void	setHyperVectorSize (size_t vector_size) const
	Sets number of I/O vectors to be read/written in hyperslab I/O. More...
size_t	getHyperVectorSize () const
	Returns the number of I/O vectors to be read/written in hyperslab I/O. More...
void	setEDCCheck (H5Z_EDC_t check) const
	Enables or disables error-detecting for a dataset reading process. More...
H5Z_EDC_t	getEDCCheck () const
	Determines whether error-detection is enabled for dataset reads. More...
virtual H5std_string	fromClass () const
	Returns this class name. More...
	DSetMemXferPropList (const DSetMemXferPropList &orig)
	Copy constructor: makes a copy of the original DSetMemXferPropList object. More...
	DSetMemXferPropList (const hid_t plist_id)
	Creates a DSetMemXferPropList object using the id of an existing DSetMemXferPropList. More...
virtual	~DSetMemXferPropList ()
	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 existance 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. 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 DSetMemXferPropList &	DEFAULT
	Default dataset memory and transfer 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::DSetMemXferPropList::DSetMemXferPropList

(

)

H5::DSetMemXferPropList::DSetMemXferPropList

(

const char *

expression

)

References setDataTransform().

H5::DSetMemXferPropList::DSetMemXferPropList

(

const DSetMemXferPropList &

original

)

Parameters

original

- IN: Original dataset memory and transfer property list object to copy

H5::DSetMemXferPropList::DSetMemXferPropList

(

const hid_t

plist_id

)

Parameters

plist_id

- IN: Id of an existing dataset memory and transfer property list

H5::DSetMemXferPropList::~DSetMemXferPropList ( )

virtual

Member Function Documentation

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

inlinevirtual

Reimplemented from H5::PropList.

void H5::DSetMemXferPropList::getBtreeRatios	(	double &	left,
		double &	middle,
		double &	right
	)		const

Parameters

left	- OUT: B-tree split ratio for left-most nodes
middle	- OUT: B-tree split ratio for right-most nodes and lone nodes
right	- OUT: B-tree split ratio for all other nodes

Exceptions

H5::PropListIException

size_t H5::DSetMemXferPropList::getBuffer	(	void **	tconv,
		void **	bkg
	)		const

Parameters

tconv	- OUT: Pointer to application-allocated type conversion buf
bkg	- OUT: Pointer to application-allocated background buffer

Returns

Buffer size, in bytes

Exceptions

H5::PropListIException

ssize_t H5::DSetMemXferPropList::getDataTransform	(	char *	exp,
		size_t	buf_size = 0
	)		const

Parameters

exp	- OUT: buffer for data transform expression (char*)
buf_size	- IN: size of buffer for expression, including the null terminator

Exceptions

H5::PropListIException

H5std_string H5::DSetMemXferPropList::getDataTransform

(

)

const

H5Z_EDC_t H5::DSetMemXferPropList::getEDCCheck

(

)

const

Returns

H5Z_ENABLE_EDC or H5Z_DISABLE_EDC

Exceptions

H5::PropListIException

size_t H5::DSetMemXferPropList::getHyperVectorSize

(

)

const

Returns

Number of I/O vectors

Exceptions

H5::PropListIException

bool H5::DSetMemXferPropList::getPreserve

(

)

const

Returns

Status of the dataset transfer property list

Exceptions

H5::PropListIException

hsize_t H5::DSetMemXferPropList::getSmallDataBlockSize

(

)

const

Returns

Size of the small data block, in bytes

Exceptions

H5::PropListIException

void H5::DSetMemXferPropList::getTypeConvCB	(	H5T_conv_except_func_t *	op,
		void **	user_data
	)		const

Parameters

op	- IN: Retrieved user function
user_data	- IN: Retrieved user data

Exceptions

H5::PropListIException

void H5::DSetMemXferPropList::getVlenMemManager	(	H5MM_allocate_t &	alloc_func,
		void **	alloc_info,
		H5MM_free_t &	free_func,
		void **	free_info
	)		const

Parameters

alloc_func	- OUT: User's allocate routine
alloc_info	- OUT: User's allocation parameters
free_func	- OUT: User's free routine
free_info	- OUT: User's free parameters

Exceptions

H5::PropListIException

void H5::DSetMemXferPropList::setBtreeRatios	(	double	left,
		double	middle,
		double	right
	)		const

Parameters

left	- IN: B-tree split ratio for left-most nodes
middle	- IN: B-tree split ratio for right-most nodes and lone nodes
right	- IN: B-tree split ratio for all other nodes

Exceptions

H5::PropListIException

void H5::DSetMemXferPropList::setBuffer	(	size_t	size,
		void *	tconv,
		void *	bkg
	)		const

Parameters

size	- IN: Size, in bytes, of the type conversion and background buffers
tconv	- IN: Pointer to application-allocated type conversion buffer
bkg	- IN: Pointer to application-allocated background buffer

Exceptions

H5::PropListIException

void H5::DSetMemXferPropList::setDataTransform

(

const char *

expression

)

const

Parameters

expression

- IN: null-terminated data transform expression (char*)

Exceptions

H5::PropListIException

Referenced by DSetMemXferPropList(), and setDataTransform().

void H5::DSetMemXferPropList::setDataTransform

(

const H5std_string &

expression

)

const

Parameters

expression

- IN: H5std_string data transform expression

Exceptions

H5::PropListIException

References setDataTransform().

void H5::DSetMemXferPropList::setEDCCheck

(

H5Z_EDC_t

check

)

const

Parameters

check

- IN: Specifies whether error detection is enabled or disabled

Exceptions

H5::PropListIException

Description

The error detection algorithm used is the algorithm previously specified in the corresponding dataset creation property list. This function does not affect the use of error detection in the writing process.

Valid values are as follows:

• H5Z_ENABLE_EDC (default)
• H5Z_DISABLE_EDC

void H5::DSetMemXferPropList::setHyperVectorSize

(

size_t

vector_size

)

const

Exceptions

H5::PropListIException

Description

For information, please refer to the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetHyperVectorSize

void H5::DSetMemXferPropList::setPreserve

(

bool

status

)

const

Parameters

status

- IN: Status to set, true or false

Exceptions

H5::PropListIException

void H5::DSetMemXferPropList::setSmallDataBlockSize

(

hsize_t

size

)

const

Parameters

size	- IN: Maximum size, in bytes, of the small data block.

Exceptions

H5::PropListIException

Description

For detail, please refer to the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSmallData

void H5::DSetMemXferPropList::setTypeConvCB	(	H5T_conv_except_func_t	op,
		void *	user_data
	)		const

Parameters

op	- IN: User's function
user_data	- IN: User's data

Exceptions

H5::PropListIException

void H5::DSetMemXferPropList::setVlenMemManager	(	H5MM_allocate_t	alloc_func,
		void *	alloc_info,
		H5MM_free_t	free_func,
		void *	free_info
	)		const

Parameters

alloc_func	- IN: User's allocate routine
alloc_info	- IN: User's allocation parameters
free_func	- IN: User's free routine
free_info	- IN: User's free parameters

Exceptions

H5::PropListIException

void H5::DSetMemXferPropList::setVlenMemManager

(

)

const

Exceptions

H5::PropListIException

Member Data Documentation

const DSetMemXferPropList& H5::DSetMemXferPropList::DEFAULT

static

---

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

• H5DxferProp.h
• H5DxferProp.cpp