HDF5 C++ API Reference Manual

 

 

H5Object.h

Go to the documentation of this file.

// C++ informative line for the emacs editor: -*- C++ -*-
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 * Copyright by The HDF Group.                                               *
 * 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://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
 * access to either file, you may request a copy from [email protected].     *
 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

#ifndef _H5Object_H
#define _H5Object_H

#include "H5Classes.h"          // constains forward class declarations

// H5Object is a baseclass.  It has these subclasses:
// Group, DataSet, and DataType.
// DataType, in turn, has several specific datatypes as subclasses.

#ifndef H5_NO_NAMESPACE
namespace H5 {
#endif

#ifndef DOXYGEN_SHOULD_SKIP_THIS
class H5_DLLCPP H5Object;  // forward declaration for UserData4Aiterate

// Define the operator function pointer for H5Aiterate().
typedef void (*attr_operator_t)( H5Object& loc/*in*/,
                                 const H5std_string attr_name/*in*/,
                                 void *operator_data/*in,out*/);

class UserData4Aiterate { // user data for attribute iteration
   public:
        attr_operator_t op;
        void* opData;
        H5Object* object;
};
#endif // DOXYGEN_SHOULD_SKIP_THIS

// The above part is being moved into Iterator, but not completed

class H5_DLLCPP H5Object : public IdComponent {
   public:
        // Creates an attribute for a group, dataset, or named datatype.
        // PropList is currently not used, so always be default.
        Attribute createAttribute( const char* name, const DataType& type, const DataSpace& space, const PropList& create_plist = PropList::DEFAULT ) const;
        Attribute createAttribute( const H5std_string& name, const DataType& type, const DataSpace& space, const PropList& create_plist = PropList::DEFAULT ) const;

        // Opens an attribute given its name.
        Attribute openAttribute( const char* name ) const;
        Attribute openAttribute( const H5std_string& name ) const;

        // Opens an attribute given its index.
        Attribute openAttribute( const unsigned int idx ) const;

        // Flushes all buffers associated with this object to disk
        void flush( H5F_scope_t scope ) const;

        // Gets the name of the file, in which this HDF5 object belongs.
        H5std_string getFileName() const;

        // Determines the number of attributes attached to this object.
        int getNumAttrs() const;

        // Iterate user's function over the attributes of this object
        int iterateAttrs( attr_operator_t user_op, unsigned* idx = NULL, void* op_data = NULL );

        // Removes the named attribute from this object.
        void removeAttr( const char* name ) const;
        void removeAttr( const H5std_string& name ) const;

        // Renames the attribute to a new name.
        void renameAttr(const char* oldname, const char* newname) const;
        void renameAttr(const H5std_string& oldname, const H5std_string& newname) const;

        // Creates a reference to a named Hdf5 object or to a dataset region
        // in this object.
        void reference(void* ref, const char* name, const DataSpace& dataspace,
                        H5R_type_t ref_type = H5R_DATASET_REGION) const;
        void reference(void* ref, const char* name) const;
        void reference(void* ref, const H5std_string& name) const;

        // Open a referenced HDF5 object whose location is specified by either
        // a file, an HDF5 object, or an attribute.
        void dereference(H5File& h5file, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        void dereference(H5Object& obj, const void* ref, H5R_type_t ref_type = H5R_OBJECT);
        void dereference(Attribute& attr, const void* ref, H5R_type_t ref_type = H5R_OBJECT);

        // Copy constructor: makes copy of an H5Object object.
        H5Object(const H5Object& original);

        // Noop destructor.
        virtual ~H5Object();

   protected:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
        // Default constructor
        H5Object();

        // Creates a copy of an existing object giving the object id
        H5Object( const hid_t object_id );

        // 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(void* ref, const char* name, hid_t space_id, H5R_type_t ref_type) const;

        // Dereferences a ref into an hdf5 id.
        hid_t p_dereference(hid_t loc_id, const void* ref, H5R_type_t ref_type);

#ifndef H5_NO_DEPRECATED_SYMBOLS
        // 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;
#endif /* H5_NO_DEPRECATED_SYMBOLS */

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

#endif // DOXYGEN_SHOULD_SKIP_THIS

}; /* end class H5Object */

#ifndef H5_NO_NAMESPACE
}
#endif
#endif

---