diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-08-06 22:19:41 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-08-06 22:19:41 (GMT) |
commit | 619d3b02d1190a2baaace1fd6c9832207be3d7d2 (patch) | |
tree | ada44cb1f2c913f82e4446729eb6b3c61e65f0cf /c++ | |
parent | f7d9933431fa922e497c47acab6eed30bf711b03 (diff) | |
download | hdf5-619d3b02d1190a2baaace1fd6c9832207be3d7d2.zip hdf5-619d3b02d1190a2baaace1fd6c9832207be3d7d2.tar.gz hdf5-619d3b02d1190a2baaace1fd6c9832207be3d7d2.tar.bz2 |
[svn-r9042] Purpose: Clean up code and update documentation
Description:
Removed an internal class from RM.
Removed an extra default constructor DataSpace().
Added header files H5ArrayType.h and H5VarLenType.h to some cpp files;
there files were missing from last checkin.
Platforms tested:
SunOS 5.7 (arabica)
Linux 2.4 (eirene)
Misc. update:
Diffstat (limited to 'c++')
-rw-r--r-- | c++/src/H5Alltypes.h | 2 | ||||
-rw-r--r-- | c++/src/H5Cpp.h | 2 | ||||
-rw-r--r-- | c++/src/H5DataSpace.cpp | 9 | ||||
-rw-r--r-- | c++/src/H5DataSpace.h | 3 | ||||
-rw-r--r-- | c++/src/H5DcreatProp.cpp | 3 | ||||
-rw-r--r-- | c++/src/H5DcreatProp.h | 2 | ||||
-rw-r--r-- | c++/src/H5RefCounter.cpp | 24 | ||||
-rw-r--r-- | c++/src/H5RefCounter.h | 22 |
8 files changed, 36 insertions, 31 deletions
diff --git a/c++/src/H5Alltypes.h b/c++/src/H5Alltypes.h index 5cd9d29..17ae0d9 100644 --- a/c++/src/H5Alltypes.h +++ b/c++/src/H5Alltypes.h @@ -24,3 +24,5 @@ #include "H5FloatType.h" #include "H5StrType.h" #include "H5CompType.h" +#include "H5ArrayType.h" +#include "H5VarLenType.h" diff --git a/c++/src/H5Cpp.h b/c++/src/H5Cpp.h index 7f80a3c..f11bbbd 100644 --- a/c++/src/H5Cpp.h +++ b/c++/src/H5Cpp.h @@ -38,6 +38,8 @@ #include "H5FloatType.h" #include "H5StrType.h" #include "H5CompType.h" +#include "H5ArrayType.h" +#include "H5VarLenType.h" #include "H5DataSet.h" #include "H5Group.h" #include "H5File.h" diff --git a/c++/src/H5DataSpace.cpp b/c++/src/H5DataSpace.cpp index 71f697b..7e0f317 100644 --- a/c++/src/H5DataSpace.cpp +++ b/c++/src/H5DataSpace.cpp @@ -36,14 +36,7 @@ namespace H5 { const DataSpace DataSpace::ALL( H5S_ALL ); //-------------------------------------------------------------------------- -// Function: DataSpace default constructor -///\brief Default constructor: creates a stub DataSpace. -// Programmer Binh-Minh Ribler - 2000 -//-------------------------------------------------------------------------- -DataSpace::DataSpace() : IdComponent() {} - -//-------------------------------------------------------------------------- -// Function: DataSpace overloaded constructor +// Function: DataSpace constructor ///\brief Creates a new dataspace given a dataspace type. ///\param type - IN: Type of the dataspace to be created, which /// currently can be either \c H5S_SCALAR or \c H5S_SIMPLE; diff --git a/c++/src/H5DataSpace.h b/c++/src/H5DataSpace.h index 6c6b72a..5e20730 100644 --- a/c++/src/H5DataSpace.h +++ b/c++/src/H5DataSpace.h @@ -102,9 +102,6 @@ class H5_DLLCPP DataSpace : public IdComponent { // Creates a DataSpace object using an existing dataspace id. DataSpace(const hid_t space_id); - // Default constructor - DataSpace(); - // Copy constructor: makes a copy of the original DataSpace object. DataSpace(const DataSpace& original); diff --git a/c++/src/H5DcreatProp.cpp b/c++/src/H5DcreatProp.cpp index 50c6351..a6260dc 100644 --- a/c++/src/H5DcreatProp.cpp +++ b/c++/src/H5DcreatProp.cpp @@ -103,7 +103,6 @@ int DSetCreatPropList::getChunk( int max_ndims, hsize_t* dim ) const //-------------------------------------------------------------------------- // Function: DSetCreatPropList::setLayout ///\brief Sets the type of storage used store the raw data for a dataset. -///\param plist - IN: Property list id, here by mistake, should be removed ///\param layout - IN: Type of storage layout for raw data ///\exception H5::PropListIException ///\par Description @@ -111,7 +110,7 @@ int DSetCreatPropList::getChunk( int max_ndims, hsize_t* dim ) const /// http://hdf.ncsa.uiuc.edu/HDF5/doc/RM_H5P.html#Property-SetLayout // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- -void DSetCreatPropList::setLayout(hid_t plist, H5D_layout_t layout ) const +void DSetCreatPropList::setLayout(H5D_layout_t layout) const { herr_t ret_value = H5Pset_layout( id, layout ); if( ret_value < 0 ) diff --git a/c++/src/H5DcreatProp.h b/c++/src/H5DcreatProp.h index e2e7361..69388ed 100644 --- a/c++/src/H5DcreatProp.h +++ b/c++/src/H5DcreatProp.h @@ -71,7 +71,7 @@ class H5_DLLCPP DSetCreatPropList : public PropList { // Sets the type of storage used to store the raw data for the // dataset that uses this property list. - void setLayout(hid_t plist, H5D_layout_t layout ) const; + void setLayout(H5D_layout_t layout) const; // Returns the number of filters in the pipeline. int getNfilters() const; diff --git a/c++/src/H5RefCounter.cpp b/c++/src/H5RefCounter.cpp index 3489996..db1c5a1 100644 --- a/c++/src/H5RefCounter.cpp +++ b/c++/src/H5RefCounter.cpp @@ -19,32 +19,32 @@ #ifndef H5_NO_NAMESPACE namespace H5 { #endif - +#ifndef DOXYGEN_SHOULD_SKIP_THIS //-------------------------------------------------------------------------- // Function: RefCounter default constructor -//=\brief Default constructor: Creates a reference counter and set it -//= to 1. +// Purpose Default constructor: Creates a reference counter and set it +// to 1. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- RefCounter::RefCounter() : counter(1) {} //-------------------------------------------------------------------------- // Function: RefCounter::getCounter -//=\brief Returns the current value of the reference counter. +// Purpose Returns the current value of the reference counter. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- int RefCounter::getCounter () const { return counter; } //-------------------------------------------------------------------------- // Function: RefCounter::increment -//=\brief Increments the reference counter. +// Purpose Increments the reference counter. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void RefCounter::increment() { counter++; } //-------------------------------------------------------------------------- // Function: RefCounter::decrement -//=\brief Decrements the reference counter. +// Purpose Decrements the reference counter. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- void RefCounter::decrement() @@ -58,11 +58,10 @@ void RefCounter::decrement() //-------------------------------------------------------------------------- // Function: RefCounter::noReference -//=\brief Returns true if there are no more reference to the object -//= that uses this counter. -//=\return true if there are no more reference to the object -//= that uses this counter, and false, otherwise. -//=\note This function will be obsolete in the next release. +// Purpose Returns true if there are no more reference to the object +// that uses this counter. +// Return true if there are no more reference to the object +// that uses this counter, and false, otherwise. // Description // Decrements the reference counter then determines if there // are no more reference to the object that uses this counter. @@ -77,10 +76,11 @@ bool RefCounter::noReference() //-------------------------------------------------------------------------- // Function: RefCounter destructor -//=\brief Noop destructor. +// Purpose Noop destructor. // Programmer Binh-Minh Ribler - 2000 //-------------------------------------------------------------------------- RefCounter::~RefCounter() {} +#endif // DOXYGEN_SHOULD_SKIP_THIS #ifndef H5_NO_NAMESPACE } // end namespace diff --git a/c++/src/H5RefCounter.h b/c++/src/H5RefCounter.h index 212515d..9f05b7b 100644 --- a/c++/src/H5RefCounter.h +++ b/c++/src/H5RefCounter.h @@ -16,24 +16,36 @@ #ifndef _H5RefCounter_H #define _H5RefCounter_H + #ifndef H5_NO_NAMESPACE namespace H5 { #endif +///\remarks The features provided by this class are now handled at +/// the C library layer; thus, the class will be removed from +/// future releases. + class H5_DLLCPP RefCounter { public: - // Creates a reference counter to be used by an HDF5 object - RefCounter(); - +#ifndef DOXYGEN_SHOULD_SKIP_THIS + // Returns the current value of the reference counter. int getCounter () const; + + // Increments the reference counter. void increment(); + + // Decrements the reference counter. void decrement(); - // this bool function is used to determine whether to close an - // HDF5 object when there are no more reference to that object + // This function is used to determine whether to close an + // HDF5 object when there are no more reference to that object. bool noReference(); + // Creates a reference counter to be used by an HDF5 object. + RefCounter(); + ~RefCounter(); +#endif // DOXYGEN_SHOULD_SKIP_THIS private: int counter; // keeps track of number of copies of an object |