IdComponent Class Reference

#include <c++/src/H5IdComponent.h>

Detailed Description

Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier.

In most cases, the C library handles these operations and an application rarely needs them.

Inheritance diagram for IdComponent:

Public Member Functions
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 hid_t	getId () const =0
virtual void	close ()=0
H5std_string	inMemFunc (const char *func_name) const
virtual H5std_string	fromClass () const
	Returns this class name.
virtual	~IdComponent ()=default

Static Public Member Functions
static H5I_type_t	getHDFObjType (const hid_t obj_id)
static hsize_t	getNumMembers (H5I_type_t type)
static bool	isValid (hid_t an_id)
static bool	typeExists (H5I_type_t type)

Protected Member Functions
	IdComponent ()
H5std_string	p_get_file_name () const
virtual void	p_setId (const hid_t new_id)=0

Static Protected Member Functions
static bool	p_valid_id (const hid_t obj_id)

Static Protected Attributes
static bool	H5dontAtexit_called

Constructor & Destructor Documentation

~IdComponent()

virtual ~IdComponent ( )

virtualdefault

IdComponent()

IdComponent ( )

protected

Member Function Documentation

close()

virtual void close ( )

pure virtual

Implemented in Attribute, DataSet, DataSpace, DataType, H5File, Group, and PropList.

decRefCount() [1/2]

void decRefCount

(

)

const

decRefCount() [2/2]

void decRefCount

(

const hid_t

obj_id

)

const

fromClass()

virtual H5std_string fromClass ( ) const

virtual

Returns this class name.

Reimplemented in ArrayType, AtomType, Attribute, CompType, DSetAccPropList, DataSet, DataSpace, DataType, DSetCreatPropList, DSetMemXferPropList, EnumType, FileAccPropList, FileCreatPropList, H5File, FloatType, Group, IntType, LinkAccPropList, LinkCreatPropList, ObjCreatPropList, PredType, PropList, StrType, and VarLenType.

getCounter() [1/2]

int getCounter

(

)

const

getCounter() [2/2]

int getCounter

(

const hid_t

obj_id

)

const

getHDFObjType() [1/2]

H5I_type_t getHDFObjType

(

)

const

getHDFObjType() [2/2]

static H5I_type_t getHDFObjType ( const hid_t  obj_id )

static

getId()

virtual hid_t getId ( ) const

pure virtual

Implemented in Attribute, DataSet, DataSpace, DataType, H5File, Group, PropList, and H5Object.

getNumMembers()

static hsize_t getNumMembers ( H5I_type_t  type )

static

incRefCount() [1/2]

void incRefCount

(

)

const

incRefCount() [2/2]

void incRefCount

(

const hid_t

obj_id

)

const

inMemFunc()

H5std_string inMemFunc

(

const char *

func_name

)

const

isValid()

static bool isValid ( hid_t  an_id )

static

operator=()

IdComponent & operator=

(

const IdComponent &

rhs

)

p_get_file_name()

H5std_string p_get_file_name ( ) const

protected

p_setId()

virtual void p_setId ( const hid_t  new_id )

protectedpure virtual

Implemented in Attribute, DataSet, DataSpace, DataType, H5File, Group, PropList, and H5Object.

p_valid_id()

static bool p_valid_id ( const hid_t  obj_id )

staticprotected

setId()

void setId

(

const hid_t

new_id

)

typeExists()

static bool typeExists ( H5I_type_t  type )

static

Field Documentation

H5dontAtexit_called

bool H5dontAtexit_called

staticprotected

---

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

• c++/src/H5IdComponent.h