H5::PropList Class Reference

Class PropList provides operations for generic property lists. More...

#include <H5PropList.h>

Inheritance diagram for H5::PropList:

Collaboration diagram for H5::PropList:

Public Member Functions
	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
virtual H5std_string	fromClass () const
	Returns this class name. More...
	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::IdComponent
static H5I_type_t	getHDFObjType (const hid_t obj_id)
static bool	isValid (hid_t an_id)

Static Public Attributes
static const PropList &	DEFAULT
	Default property list. 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

Protected Attributes
hid_t	id

Static Private Member Functions
static PropList *	getConstant ()

Static Private Attributes
static PropList *	DEFAULT_

Friends
void	f_PropList_setId (PropList *plist, 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 PropList provides operations for generic property lists.

Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.

Definition at line 26 of file H5PropList.h.

Constructor & Destructor Documentation

PropList() [1/3]

H5::PropList::PropList

(

const hid_t

plist_id

)

PropList() [2/3]

H5::PropList::PropList

(

)

PropList() [3/3]

H5::PropList::PropList

(

const PropList &

original

)

~PropList()

virtual H5::PropList::~PropList ( )

virtual

Member Function Documentation

close()

virtual void H5::PropList::close ( )

virtual

Implements H5::IdComponent.

closeClass()

void H5::PropList::closeClass

(

)

const

copy()

void H5::PropList::copy

(

const PropList &

like_plist

)

copyProp() [1/4]

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

copyProp() [2/4]

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

copyProp() [3/4]

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

copyProp() [4/4]

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

deleteConstants()

static void H5::PropList::deleteConstants ( )

static

fromClass()

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

inlinevirtual

Returns this class name.

Reimplemented from H5::IdComponent.

Reimplemented in H5::FileAccPropList, H5::DSetCreatPropList, H5::DSetMemXferPropList, H5::FileCreatPropList, H5::ObjCreatPropList, H5::LinkAccPropList, H5::AttrCreatPropList, H5::LinkCreatPropList, and H5::StrCreatPropList.

Definition at line 100 of file H5PropList.h.

getClass()

hid_t H5::PropList::getClass

(

)

const

getClassName()

H5std_string H5::PropList::getClassName

(

)

const

getClassParent()

PropList H5::PropList::getClassParent

(

)

const

getConstant()

static PropList* H5::PropList::getConstant ( )

staticprivate

getId()

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

virtual

Implements H5::IdComponent.

getNumProps()

size_t H5::PropList::getNumProps

(

)

const

getProperty() [1/4]

void H5::PropList::getProperty	(	const char *	name,
		void *	value
	)		const

getProperty() [2/4]

void H5::PropList::getProperty	(	const H5std_string &	name,
		void *	value
	)		const

getProperty() [3/4]

H5std_string H5::PropList::getProperty

(

const char *

name

)

const

getProperty() [4/4]

H5std_string H5::PropList::getProperty

(

const H5std_string &

name

)

const

getPropSize() [1/2]

size_t H5::PropList::getPropSize

(

const char *

name

)

const

getPropSize() [2/2]

size_t H5::PropList::getPropSize

(

const H5std_string &

name

)

const

isAClass()

bool H5::PropList::isAClass

(

const PropList &

prop_class

)

const

operator=()

PropList& H5::PropList::operator=

(

const PropList &

rhs

)

operator==()

bool H5::PropList::operator==

(

const PropList &

rhs

)

const

p_setId()

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

protectedvirtual

Implements H5::IdComponent.

propExist() [1/2]

bool H5::PropList::propExist

(

const char *

name

)

const

Query the existance of a property in a property object.

propExist() [2/2]

bool H5::PropList::propExist

(

const H5std_string &

name

)

const

removeProp() [1/2]

void H5::PropList::removeProp

(

const char *

name

)

const

removeProp() [2/2]

void H5::PropList::removeProp

(

const H5std_string &

name

)

const

setProperty() [1/5]

void H5::PropList::setProperty	(	const char *	name,
		void *	value
	)		const

setProperty() [2/5]

void H5::PropList::setProperty	(	const char *	name,
		const char *	charptr
	)		const

setProperty() [3/5]

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

setProperty() [4/5]

void H5::PropList::setProperty	(	const H5std_string &	name,
		void *	value
	)		const

setProperty() [5/5]

void H5::PropList::setProperty	(	const H5std_string &	name,
		H5std_string &	strg
	)		const

Friends And Related Function Documentation

f_PropList_setId

void f_PropList_setId ( PropList *  plist, hid_t  new_id  )

friend

Field Documentation

DEFAULT

const PropList& H5::PropList::DEFAULT

static

Default property list.

Definition at line 29 of file H5PropList.h.

DEFAULT_

PropList* H5::PropList::DEFAULT_

staticprivate

Definition at line 126 of file H5PropList.h.

id

hid_t H5::PropList::id

protected

Definition at line 120 of file H5PropList.h.

---

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

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