HDF5 C++ API Reference Manual

 

 

 

H5IdComponent.h

Go to the documentation of this file.

// C++ informative line for the emacs editor: -*- C++ -*-
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by the Board of Trustees of the University of Illinois.     *
 * All rights reserved.                                               *
 *                                                                         *
 * This file is part of HDF5.  The full HDF5 copyright notice, including     *
 * terms governing use, modification, and redistribution, is contained in    *
 * the files COPYING and Copyright.html.  COPYING can be found at the root   *
 * of the source code distribution tree; Copyright.html can be found at the  *
 * root level of an installed copy of the electronic HDF5 document set and   *
 * is linked from the top-level documents page.  It can also be found at     *
 * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
 * access to either file, you may request a copy from [email protected]. *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef _IdComponent_H
#define _IdComponent_H

// IdComponent provides a mechanism to handle
// reference counting for an identifier of any HDF5 object.

#ifndef H5_NO_NAMESPACE
namespace H5 {
#ifndef H5_NO_STD
    using std::string;
#endif  // H5_NO_STD
#endif

class H5_DLLCPP IdComponent {
   public:
        // Increment reference counter.
        void incRefCount(hid_t obj_id) const;
        void incRefCount() const;

        // Decrement reference counter.
        void decRefCount(hid_t obj_id) const;
        void decRefCount() const;

        // Get the reference counter to this identifier.
        int getCounter(hid_t obj_id) const;
        int getCounter() const;

        // Assignment operator
        IdComponent& operator=( const IdComponent& rhs );

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

        // Creates an object to hold an HDF5 identifier.
        IdComponent( const hid_t h5_id );

        // Copy constructor: makes copy of the original IdComponent object.
        IdComponent( const IdComponent& original );

        // Gets the value of IdComponent's data member.
        virtual hid_t getId () const;

#ifndef DOXYGEN_SHOULD_SKIP_THIS
        // Pure virtual function for there are various H5*close for the
        // subclasses.
        virtual void close() = 0;

#endif // DOXYGEN_SHOULD_SKIP_THIS

        // Makes and returns the string "<class-name>::<func_name>";
        // <class-name> is returned by fromClass().
        string inMemFunc(const char* func_name) const;

        // Returns this class name.
        virtual string fromClass() const {return ("IdComponent");}

        // Destructor
        virtual ~IdComponent();

   protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
        hid_t id;       // HDF5 object id

        // Default constructor.
        IdComponent();

        // Gets the name of the file, in which an HDF5 object belongs.
#ifndef H5_NO_STD
        std::string p_get_file_name() const;
#else
        string p_get_file_name() const;
#endif  // H5_NO_STD

        // Gets the id of the H5 file in which the given object is located.
        hid_t p_get_file_id();

        // Creates a reference to an HDF5 object or a dataset region.
        void* p_reference(const char* name, hid_t space_id, H5R_type_t ref_type) const;

        // Retrieves the type of object that an object reference points to.
        H5G_obj_t p_get_obj_type(void *ref, H5R_type_t ref_type) const;

        // Retrieves a dataspace with the region pointed to selected.
        hid_t p_get_region(void *ref, H5R_type_t ref_type) const;

        // Verifies that the given id is valid.
        bool p_valid_id(hid_t obj_id) const;

#endif // DOXYGEN_SHOULD_SKIP_THIS

}; // end class IdComponent

#ifndef H5_NO_NAMESPACE
}
#endif
#endif

---