diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2000-11-14 21:30:12 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2000-11-14 21:30:12 (GMT) |
commit | 92041a68656c59813619ae1f26ed211b7f028e86 (patch) | |
tree | aaa3256c9a9f0adde21570eac9254f7ce00450b1 /c++/src/H5CommonFG.h | |
parent | 36acd5381e3977164e0d6d666f8ce97cc53f9387 (diff) | |
download | hdf5-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/H5CommonFG.h')
-rw-r--r-- | c++/src/H5CommonFG.h | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/c++/src/H5CommonFG.h b/c++/src/H5CommonFG.h new file mode 100644 index 0000000..68c6bec --- /dev/null +++ b/c++/src/H5CommonFG.h @@ -0,0 +1,62 @@ +/* +These functions provide code that are common to both H5File and Group. +Some of the member functions of these two classes call a common function +and provide it a file or group id to perform a task that can be done on +either an H5File or Group instance. 10/31/00 + +The name of the functions ends with a T because these functions were +template functions until it was realized that more than one of our +supported platforms have not supported template functions. +*/ + +#ifndef _CommonFG_H +#define _CommonFG_H + +#ifndef H5_NO_NAMESPACE +namespace H5 { +#endif + +// Creates a new group at this location which can be a file or another group. +Group createGroupT( const hid_t loc_id, const string name, size_t size_hint ); + +// Opens an existing group in a location which can be a file or another group +Group openGroupT( const hid_t loc_id, const string name ); + +// Creates a new dataset at this location. +DataSet createDataSetT( const hid_t loc_id, const string name, const DataType& data_type, const DataSpace& data_space, const DSetCreatPropList& create_plist ); + +// Opens an existing dataset at this location. +DataSet openDataSetT( const hid_t loc_id, const string name ); + +// Creates a link of the specified type from new_name to current_name; +// both names are interpreted relative to the specified location id +void linkT( const hid_t loc_id, H5G_link_t link_type, const string curr_name, const string new_name ); + +// Removes the specified name at this location. +void unlinkT( const hid_t loc_id, const string name ); + +// Renames an object at this location. +void moveT( const hid_t loc_id, const string src, const string dst ); + +// Returns information about an object +void getObjinfoT( const hid_t loc_id, const string name, hbool_t follow_link, H5G_stat_t& statbuf ); + +// Returns the name of the object that the symbolic link points to. +string getLinkvalT( const hid_t loc_id, const string name, size_t size ); + +// Sets the comment for an object specified by its name +void setCommentT( const hid_t loc_id, const string name, const string comment ); + +// Retrieves comment for specified object +string getCommentT( const hid_t loc_id, const string name, size_t bufsize ); + +// Mounts the file 'child' onto this group +void mountT( const hid_t loc_id, const string name, hid_t child_id, PropList& plist ); + +// Unmounts the file named 'name' from this parent group +void unmountT( const hid_t loc_id, const string name ); +#ifndef H5_NO_NAMESPACE +} +#endif +#endif + |