HDF5 C++ API Reference Manual

 

 

 

H5::IdComponent Class Reference

#include <H5IdComponent.h>

Inheritance diagram for H5::IdComponent:

List of all members.

Public Member Functions
void	incRefCount ()
	Increments id reference counter.
void	decRefCount ()
	Decrements id reference counter.
int	getCounter ()
	Returns the reference counter to this identifier.
bool	noReference ()
	Determines whether this object has any references.
IdComponent &	operator= (const IdComponent &rhs)
	Assignment operator.
void	reset ()
	Reset this object by deleting/resetting its reference counter.
void	setId (hid_t new_id)
	Sets the identifier of this object to a new value.
	IdComponent (const hid_t h5_id)
	Creates an IdComponent object using the id of an existing object.
	IdComponent (const IdComponent &original)
	Copy constructor: makes a copy of the original IdComponent object.
virtual hid_t	getId () const
	Returns the id of this object.
virtual	~IdComponent ()
	Noop destructor.

---

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.

---

Member Function Documentation

void H5::IdComponent::incRefCount (   )

Increments id reference counter.

void H5::IdComponent::decRefCount (   )

Decrements id reference counter.

int H5::IdComponent::getCounter (   )

Returns the reference counter to this identifier. Returns: Reference count

bool H5::IdComponent::noReference (   )

Determines whether this object has any references. Returns: true if there is no reference, and false, otherwise. Note: This function will be obsolete in the next release.

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

void H5::IdComponent::reset (   )

Reset this object by deleting/resetting its reference counter. Returns: HDF5 object id

void H5::IdComponent::setId (  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 Description: The calling routine must reset the id of this object by calling resetIdComponent and passing in the "this" pointer. resetIdComponent ensures that the HDF5 id will be appropriately closed. If only this object references its id, its reference counter will be deleted. A new reference counter is created for the new HDF5 object id.

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

Returns the id of this object. Returns: HDF5 object id Reimplemented in H5::PredType.

---