H5::IdComponent Class Reference

List of all members.

Public Member Functions

• void incRefCount (const 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 (const 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 (const 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.
  

• virtual hid_t getId () const =0
• void setId (const 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 void close ()=0
• H5std_string inMemFunc (const char *func_name) const

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

• virtual H5std_string fromClass () const

  Returns this class name.
  

• virtual ~IdComponent ()

  Noop destructor.
  

Static Public Member Functions

• static H5I_type_t getHDFObjType (const hid_t obj_id)

  Given an id, returns the type of the object.
  

Protected Member Functions

• IdComponent ()

  Default constructor.
  

• 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)

---

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

---

Member Function Documentation

int H5::IdComponent::getCounter

(

)

const

Returns the reference counter for the id of this object.

Returns:

Reference count

Referenced by H5::PropList::close(), H5::Group::close(), H5::H5File::close(), H5::DataType::close(), H5::DataSpace::close(), and H5::DataSet::close().

int H5::IdComponent::getCounter

(

const hid_t

obj_id

)

const

Returns the reference counter for a given id.

Returns:

Reference count

References inMemFunc().

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.

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.

References fromClass().

Referenced by H5::PropList::close(), H5::DataType::close(), H5::PropList::closeClass(), H5::DataType::committed(), H5::DataType::convert(), H5::PropList::copy(), H5::DataType::copy(), H5::PropList::copyProp(), H5::H5Object::createAttribute(), decRefCount(), H5::DataType::detectClass(), H5::DataType::find(), H5::H5Object::flush(), H5::PropList::getClass(), H5::DataType::getClass(), H5::PropList::getClassParent(), getCounter(), H5::H5Object::getFileName(), H5::H5Object::getNumAttrs(), H5::PropList::getNumProps(), H5::DataType::getObjType(), H5::AtomType::getOffset(), H5::AtomType::getOrder(), H5::AtomType::getPad(), H5::AtomType::getPrecision(), H5::PropList::getProperty(), H5::PropList::getPropSize(), H5::DataType::getRegion(), H5::DataType::getSize(), H5::DataType::getSuper(), H5::DataType::getTag(), incRefCount(), H5::PropList::isAClass(), H5::DataType::isVariableStr(), H5::H5Object::iterateAttrs(), H5::DataType::lock(), H5::H5Object::openAttribute(), operator=(), H5::PropList::operator==(), H5::DataType::operator==(), H5::PropList::p_setId(), H5::DataType::p_setId(), H5::DataSpace::p_setId(), H5::DataSet::p_setId(), H5::PropList::propExist(), H5::DataType::registerFunc(), H5::H5Object::removeAttr(), H5::PropList::removeProp(), H5::H5Object::renameAttr(), H5::AtomType::setOffset(), H5::AtomType::setOrder(), H5::AtomType::setPad(), H5::AtomType::setPrecision(), H5::PropList::setProperty(), H5::AtomType::setSize(), H5::DataType::setTag(), H5::DataType::unregister(), and H5::DataType::~DataType().

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

References H5::Exception::getDetailMsg(), inMemFunc(), and setId().

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

References incRefCount().

Referenced by operator=().