summaryrefslogtreecommitdiffstats
path: root/c++/src/H5IdComponent.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2004-07-31 04:54:08 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2004-07-31 04:54:08 (GMT)
commitfddc43caad965b3cfef964ba02195d211d51669e (patch)
tree9f88cbfe03f70b0f9df981da9ae71b5557665227 /c++/src/H5IdComponent.h
parente8671d70c3bf755472c54d9740c694757bb5749e (diff)
downloadhdf5-fddc43caad965b3cfef964ba02195d211d51669e.zip
hdf5-fddc43caad965b3cfef964ba02195d211d51669e.tar.gz
hdf5-fddc43caad965b3cfef964ba02195d211d51669e.tar.bz2
[svn-r8973] Purpose: Updated documentation
Description: Updated various function headers for the RM as reviewing progresses. Rearranged functions in header files for more sensible look of the RM. Platforms tested: SunOS 5.7 (arabica) Linux 2.4 (verbena)
Diffstat (limited to 'c++/src/H5IdComponent.h')
-rw-r--r--c++/src/H5IdComponent.h27
1 files changed, 13 insertions, 14 deletions
diff --git a/c++/src/H5IdComponent.h b/c++/src/H5IdComponent.h
index bea8cd4..5c84990 100644
--- a/c++/src/H5IdComponent.h
+++ b/c++/src/H5IdComponent.h
@@ -25,19 +25,6 @@ namespace H5 {
class H5_DLLCPP IdComponent {
public:
- // Parent classes must reset the current IdComponent copy
- // before setting new id to control reference count
- void setId( hid_t new_id );
-
- // Creates an object to hold an HDF5 identifier
- IdComponent( const hid_t h5_id );
-
- // Copy constructor: makes copy of the original IdComponent object.
- IdComponent( const IdComponent& original );
-
- // Gets the value of IdComponent's data member
- virtual hid_t getId () const;
-
// Increment reference counter
void incRefCount();
@@ -56,6 +43,18 @@ class H5_DLLCPP IdComponent {
void reset();
+ // Sets the identifier of this object to a new value.
+ void setId( hid_t new_id );
+
+ // Creates an object to hold an HDF5 identifier
+ IdComponent( const hid_t h5_id );
+
+ // Copy constructor: makes copy of the original IdComponent object.
+ IdComponent( const IdComponent& original );
+
+ // Gets the value of IdComponent's data member
+ virtual hid_t getId () const;
+
// Pure virtual function so appropriate close function can
// be called by subclasses' for the corresponding object
// This function will be obsolete because its functionality
@@ -73,7 +72,7 @@ class H5_DLLCPP IdComponent {
RefCounter* ref_count; // used to keep track of the
// number of copies of an object
- // Default constructor
+ // Default constructor.
IdComponent();
// Gets the name of the file, in which an HDF5 object belongs.