summaryrefslogtreecommitdiffstats
path: root/c++/src/H5Object.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2000-11-14 21:30:12 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2000-11-14 21:30:12 (GMT)
commit92041a68656c59813619ae1f26ed211b7f028e86 (patch)
treeaaa3256c9a9f0adde21570eac9254f7ce00450b1 /c++/src/H5Object.h
parent36acd5381e3977164e0d6d666f8ce97cc53f9387 (diff)
downloadhdf5-92041a68656c59813619ae1f26ed211b7f028e86.zip
hdf5-92041a68656c59813619ae1f26ed211b7f028e86.tar.gz
hdf5-92041a68656c59813619ae1f26ed211b7f028e86.tar.bz2
[svn-r2897] Purpose:
C++ API for 1.3.x branch Description: The *.C and *.h files named different than those in 1.2.x. They are in the form: 'H5' + classname, or just classname if the classname is already prefixed with 'H5' to avoid ambiguity in documentation context. This version has several hidden bugs fixed and an improvement on the reference counting approach. The classes and their inheritance structure are listed below: --------------------------------------- H5Library Exception RefCounter IdComponent H5File DataSpace H5Object Group AbstractDs DataSet Attribute DataType PredType EnumType CompType AtomType StrType IntType FloatType PropList FileCreatPropList FileAccPropList DSetCreatPropList DSetMemXferPropList --------------------------------------- IdComponent uses RefCounter to keep track of opened objects so proper termination of HDF5 objects can be maintained. Each class has a .h file containing the class declaration and a .C file containing its definition. In addition to the classes files, the following files do not have class information: - H5Cpp.h: header file to be included in user's application - H5Idtemplates.h: contains a template function used by several classes - H5Classes.h: contains forward class declarations - H5CommonFG.*: contains common code used by classes H5File and Group - H5Include.h: contains the hdf5.h header file and the #undef RCSID to work around the problem: multiple defined RcsId - H5Alltypes.h: simply serves as a container to hold the header files of all datatypes to simplify the header file inclusion Platforms: Solaris (arabica) and Linux
Diffstat (limited to 'c++/src/H5Object.h')
-rw-r--r--c++/src/H5Object.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/c++/src/H5Object.h b/c++/src/H5Object.h
new file mode 100644
index 0000000..65e7119
--- /dev/null
+++ b/c++/src/H5Object.h
@@ -0,0 +1,88 @@
+#ifndef _H5Object_H
+#define _H5Object_H
+
+#include "H5Classes.h" // constains forward class declarations
+
+// H5Object is a baseclass. It has these subclasses:
+// Group, AbstractDs, and DataType.
+// AbstractDs, in turn, has subclasses DataSet and Attribute.
+// DataType, in turn, has several specific datatypes as subclasses.
+
+#ifndef H5_NO_NAMESPACE
+namespace H5 {
+#endif
+
+class H5Object; // forward declaration for UserData4Aiterate
+
+// Define the operator function pointer for H5Aiterate().
+typedef void (*attr_operator_t)( H5Object& loc/*in*/,
+ const string attr_name/*in*/,
+ void *operator_data/*in,out*/);
+
+class UserData4Aiterate { // user data for attribute iteration
+ public:
+ unsigned int* idx;
+ attr_operator_t op;
+ void* opData;
+ H5Object* object;
+};
+
+// The above part is being moved into Iterator, but not completed
+
+class H5Object : public IdComponent {
+ public:
+ // Pure virtual function so appropriate close function can
+ // be called by subclasses' for the corresponding HDF5 object
+ //virtual void p_close() const = 0;
+
+ // Copy constructor: makes copy of an H5Object object.
+ H5Object( const H5Object& original );
+
+ // Flushes all buffers associated with this object to disk
+ void flush( H5F_scope_t scope ) const;
+
+ // Assignment operator
+ //H5Object& operator=( const H5Object& rhs );
+
+ // Sets and gets H5Object's data member
+ //void setId( hid_t new_id );
+ //hid_t getId () const;
+
+ // 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 string& name, const DataType& type, const DataSpace& space, const PropList& create_plist = PropList::DEFAULT ) const;
+
+ // Opens an attribute given its name.
+ Attribute openAttribute( const string& name ) const;
+ Attribute openAttribute( const char* name ) const;
+
+ // Opens an attribute given its index.
+ Attribute openAttribute( const unsigned int idx ) 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 );
+
+ // Determines the number of attributes attached to this object.
+ int getNumAttrs() const;
+
+ // Removes the named attribute from this object.
+ void removeAttr( const string& name ) const;
+ void removeAttr( const char* name ) const;
+
+ virtual ~H5Object();
+
+ protected:
+
+ // Default constructor
+ H5Object();
+
+ // Creates a copy of an existing object giving the object id
+ H5Object( const hid_t object_id );
+
+}; /* end class H5Object */
+
+#ifndef H5_NO_NAMESPACE
+}
+#endif
+#endif