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 (hid_t obj_id) const
	Increment reference counter for a given id.
void	incRefCount () const
	Increment reference counter for the id of this object.
void	decRefCount (hid_t obj_id) const
	Decrement reference counter for a given id.
void	decRefCount () const
	Decrement reference counter for the id of this object.
int	getCounter (hid_t obj_id) const
	Returns the reference counter for a given id.
int	getCounter () const
	Returns the reference counter for the id of this object.
IdComponent &	operator= (const IdComponent &rhs)
	Assignment operator.
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.
string	inMemFunc (const char *func_name) const
virtual string	fromClass () const
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 (  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.

void H5::IdComponent::decRefCount (  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.

int H5::IdComponent::getCounter (  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

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::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

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

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

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

virtual string H5::IdComponent::fromClass (   )  const [inline, virtual]

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

---