[svn-r8576] Purpose:

Add more C++ wrapper and documentation - incrementally check-in

Description:
    Added doxygen documentation to:
        H5DataSet.cpp
        H5DataSpace.cpp
        H5CommonFG.cpp

    and a wrapper for H5Rcreate to H5Object.* with tests will be added
    later.

    There are more documentation need to be added to these files but
    to preserve the changes, I check them in now.

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


Misc. update:
This commit is contained in:
Binh-Minh Ribler
2004-05-26 02:02:51 -05:00
parent 2e588eef3f
commit 80816a3dde
7 changed files with 871 additions and 181 deletions

View File

@@ -262,7 +262,7 @@ void H5Object::removeAttr( const string& name ) const
}
//--------------------------------------------------------------------------
// Function: H5Object::getNumAttrs
// Function: H5Object::flush
///\brief Flushes all buffers associated with a file to disk.
///\param scope - IN: Specifies the scope of the flushing action,
/// which can be either of these values:
@@ -282,6 +282,26 @@ void H5Object::flush(H5F_scope_t scope ) const
}
}
//--------------------------------------------------------------------------
// Function: H5Object::Reference
///\brief Creates a reference.
///\param name - IN: Name of the object to be referenced
///\return A reference
///\exception H5::ReferenceIException
// Programmer Binh-Minh Ribler - May, 2004
//--------------------------------------------------------------------------
void* H5Object::Reference(const char* name, H5R_type_t ref_type, DataSpace& dataspace) const
{
void *ref;
herr_t ret_value = H5Rcreate(ref, id, name, ref_type, dataspace.getId());
if (ret_value < 0)
{
throw AttributeIException("H5Object::getNumAttrs",
"H5Aget_num_attrs failed - returned negative number of attributes");
}
return(ref);
}
//--------------------------------------------------------------------------
// Function: H5Object destructor
///\brief Subclasses destructors will properly terminate access to