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

#include <H5IdComponent.h>

Inheritance diagram for H5::IdComponent:

Public Member Functions
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...

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

virtual hid_t	getId () const =0

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

	IdComponent (const hid_t h5_id)
	Creates an IdComponent object using the id of an existing object. More...

	IdComponent (const IdComponent &original)
	Copy constructor: makes a copy of the original IdComponent object. More...

virtual void	close ()=0

H5std_string	inMemFunc (const char *func_name) const
	Makes and returns string "<class-name>::<func_name>". More...

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

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

Static Public Member Functions
static H5I_type_t	getHDFObjType (const hid_t obj_id)
	Given an id, returns the type of the object. More...

Protected Member Functions
	IdComponent ()
	Default constructor. More...

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)

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.

Constructor & Destructor Documentation

H5::IdComponent::IdComponent ( const hid_t h5_id )

Creates an IdComponent object using the id of an existing object.

Parameters

h5_id - IN: Id of an existing object

Exceptions

H5::DataTypeIException

H5::IdComponent::IdComponent ( const IdComponent & original )

Copy constructor: makes a copy of the original IdComponent object.

Parameters

original - IN: IdComponent instance to copy

H5::IdComponent::~IdComponent ( )

virtual

Noop destructor.

H5::IdComponent::IdComponent ( )

protected

Default constructor.

Member Function Documentation

virtual void H5::IdComponent::close ( )

pure virtual

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

void H5::IdComponent::decRefCount ( const hid_t obj_id ) const

Decrement reference counter for a given id.

void H5::IdComponent::decRefCount ( ) const

Decrement reference counter for the id of this object.

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

inlinevirtual

Returns this class name.

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

int H5::IdComponent::getCounter ( const hid_t obj_id ) const

Returns the reference counter for a given id.

Returns: Reference count

int H5::IdComponent::getCounter ( ) const

Returns the reference counter for the id of this object.

Returns: Reference count

H5I_type_t H5::IdComponent::getHDFObjType ( const hid_t obj_id )

static

Given an id, returns the type of the object.

Returns

a valid HDF object type, which may be one of the following:

H5I_FILE
H5I_GROUP
H5I_DATATYPE
H5I_DATASPACE
H5I_DATASET
H5I_ATTR
or H5I_BADID, if no valid type can be determined or the input object id is invalid.

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

pure virtual

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

void H5::IdComponent::incRefCount ( const hid_t obj_id ) const

Increment reference counter for a given id.

void H5::IdComponent::incRefCount ( ) const

Increment reference counter for the id of this object.

H5std_string H5::IdComponent::inMemFunc ( const char * func_name ) const

Makes and returns string "<class-name>::<func_name>".

Parameters

func_name - Name of the function where failure occurs Concatenates the class name of this object with the passed-in function name to create a string that indicates where the failure occurs. The class-name is provided by fromClass(). This string will be used by a base class when an exception is thrown.

IdComponent & H5::IdComponent::operator= ( const IdComponent & rhs )

Assignment operator.

Parameters

rhs	- IN: Reference to the existing object

Returns: Reference to IdComponent instance

Exceptions

H5::IdComponentException when attempt to close the HDF5 object fails

H5std_string H5::IdComponent::p_get_file_name ( ) const

protected

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

protectedpure virtual

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

bool H5::IdComponent::p_valid_id ( const hid_t obj_id )

staticprotected

void H5::IdComponent::setId ( const hid_t new_id )

Sets the identifier of this object to a new value.

Exceptions

H5::IdComponentException when the attempt to close the HDF5 object fails

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation