diff options
author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-08-20 04:35:18 (GMT) |
---|---|---|
committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2004-08-20 04:35:18 (GMT) |
commit | 824ba5e2fde476934df42284271c358b14e1a6af (patch) | |
tree | caf62890a1527b0fdc2a77a550c7e11f30c48584 /c++/src/H5PredType.h | |
parent | b142a4144862b22c37c27aa11e2ee519a08ede2f (diff) | |
download | hdf5-824ba5e2fde476934df42284271c358b14e1a6af.zip hdf5-824ba5e2fde476934df42284271c358b14e1a6af.tar.gz hdf5-824ba5e2fde476934df42284271c358b14e1a6af.tar.bz2 |
[svn-r9129] Purpose: Updating 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 (eirene)
Diffstat (limited to 'c++/src/H5PredType.h')
-rw-r--r-- | c++/src/H5PredType.h | 25 |
1 files changed, 16 insertions, 9 deletions
diff --git a/c++/src/H5PredType.h b/c++/src/H5PredType.h index 6529425..d75cdcc 100644 --- a/c++/src/H5PredType.h +++ b/c++/src/H5PredType.h @@ -27,15 +27,17 @@ namespace H5 { class H5_DLLCPP PredType : public AtomType { public: - // Default destructor - virtual ~PredType(); - - // Copy constructor - makes copy of the original object - PredType( const PredType& original ); + // Makes a copy of the predefined type and stores the new + // id in the left hand side object. + PredType& operator=( const PredType& rhs ); + // Returns the HDF5 predefined type id. virtual hid_t getId() const; - // Declaration of predefined types; their definition is in Predtype.C + // Noop destructor + virtual ~PredType(); + + // Declaration of predefined types; their definition is in H5PredType.cpp static const PredType STD_I8BE; static const PredType STD_I8LE; static const PredType STD_I16BE; @@ -173,11 +175,13 @@ class H5_DLLCPP PredType : public AtomType { static const PredType NATIVE_INT_FAST64; static const PredType NATIVE_UINT_FAST64; +#ifndef DOXYGEN_SHOULD_SKIP_THIS // These dummy functions do not inherit from DataType - they'll // throw a DataTypeIException if invoked. void commit( H5Object& loc, const string& name ); void commit( H5Object& loc, const char* name ); bool committed(); +#endif // DOXYGEN_SHOULD_SKIP_THIS private: // added this to work around the atexit/global destructor problem @@ -233,15 +237,18 @@ class H5_DLLCPP PredType : public AtomType { }; protected: +#ifndef DOXYGEN_SHOULD_SKIP_THIS // Default constructor PredType(); // Creates a pre-defined type using an HDF5 pre-defined constant PredType( const hid_t predtype_id ); // used by the library only - // Makes a copy of the predefined type and stores the new - // id in the left hand side object. - PredType& operator=( const PredType& rhs ); + // Copy constructor - makes copy of the original object + PredType( const PredType& original ); + +#endif // DOXYGEN_SHOULD_SKIP_THIS + }; #ifndef H5_NO_NAMESPACE } |