philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[svn-r8595] Purpose:

Browse Source 
Add/Improve documentation

Description
    Added doxygen documentation to H5PredType.cpp and made minor changes
    to the others for either correction or clarification.

Platforms:
    SunOS 5.7 (arabica)
    Linux 2.4 (eirene)

Misc. update:
This commit is contained in:
Binh-Minh Ribler
2004-05-28 01:25:56 -05:00
parent 2f4d0aad24
commit dee9ad2b7e
19 changed files with 131 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
c++/src/H5Object.h
View File

@@ -46,31 +46,20 @@ class UserData4Aiterate { // user data for attribute iteration
class H5_DLLCPP 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;
Attribute openAttribute( const string& name ) const;
// Opens an attribute given its index.
Attribute openAttribute( const unsigned int idx ) const;
@@ -82,15 +71,14 @@ class H5_DLLCPP H5Object : public IdComponent {
int getNumAttrs() const;
// Removes the named attribute from this object.
void removeAttr( const string& name ) const;
void removeAttr( const char* name ) const;
void removeAttr( const string& name ) const;
// Creates a reference to a named Hdf5 object in this object.
void* Reference(const char* name) const;
// Creates a reference to a dataset region in this object.
void* Reference(const char* name, DataSpace& dataspace, H5R_type_t ref_type = H5R_DATASET_REGION) const;
virtual ~H5Object();
protected: