diff options
author | Larry Knox <lrknox@hdfgroup.org> | 2017-04-14 16:32:51 (GMT) |
---|---|---|
committer | Larry Knox <lrknox@hdfgroup.org> | 2017-04-14 16:32:51 (GMT) |
commit | b9b207e4b04ac485167c8985ada8ca118170c9ed (patch) | |
tree | 4e35a442e01f1d21688088f68cf6d12a390c45e0 | |
parent | 071e99147a37ca34cdfb2c1012b8c73cf0e50aee (diff) | |
parent | 1b907d93d7ec3d8beb64cb084ceb2c9b4b436cbb (diff) | |
download | hdf5-b9b207e4b04ac485167c8985ada8ca118170c9ed.zip hdf5-b9b207e4b04ac485167c8985ada8ca118170c9ed.tar.gz hdf5-b9b207e4b04ac485167c8985ada8ca118170c9ed.tar.bz2 |
Merge pull request #420 in HDFFV/hdf5 from ~BMRIBLER/hdf5_1_8_bmr:hdf5_1_8 to hdf5_1_8
* commit '1b907d93d7ec3d8beb64cb084ceb2c9b4b436cbb':
Miscellaneous clean-up: format and comments Platforms tested: Linux/64 (jelly) - very minor
-rw-r--r-- | c++/src/H5AbstractDs.h | 8 | ||||
-rw-r--r-- | c++/src/H5ArrayType.h | 9 | ||||
-rw-r--r-- | c++/src/H5AtomType.h | 9 | ||||
-rw-r--r-- | c++/src/H5Attribute.h | 8 | ||||
-rw-r--r-- | c++/src/H5Classes.h | 1 | ||||
-rw-r--r-- | c++/src/H5CommonFG.cpp | 3 | ||||
-rw-r--r-- | c++/src/H5CommonFG.h | 5 | ||||
-rw-r--r-- | c++/src/H5CompType.h | 9 | ||||
-rw-r--r-- | c++/src/H5DataSet.h | 8 | ||||
-rw-r--r-- | c++/src/H5DataSpace.h | 12 | ||||
-rw-r--r-- | c++/src/H5DataType.h | 12 | ||||
-rw-r--r-- | c++/src/H5DcreatProp.h | 16 | ||||
-rw-r--r-- | c++/src/H5DxferProp.h | 16 | ||||
-rw-r--r-- | c++/src/H5EnumType.h | 12 | ||||
-rw-r--r-- | c++/src/H5Exception.h | 5 | ||||
-rw-r--r-- | c++/src/H5FaccProp.h | 14 | ||||
-rw-r--r-- | c++/src/H5FcreatProp.h | 11 | ||||
-rw-r--r-- | c++/src/H5File.h | 8 | ||||
-rw-r--r-- | c++/src/H5FloatType.h | 12 | ||||
-rw-r--r-- | c++/src/H5Group.h | 8 | ||||
-rw-r--r-- | c++/src/H5IdComponent.h | 4 | ||||
-rw-r--r-- | c++/src/H5IntType.h | 12 | ||||
-rw-r--r-- | c++/src/H5Library.h | 6 | ||||
-rw-r--r-- | c++/src/H5Location.h | 13 | ||||
-rw-r--r-- | c++/src/H5Object.h | 33 | ||||
-rw-r--r-- | c++/src/H5OcreatProp.h | 11 | ||||
-rw-r--r-- | c++/src/H5PredType.h | 8 | ||||
-rw-r--r-- | c++/src/H5PropList.h | 12 | ||||
-rw-r--r-- | c++/src/H5StrType.h | 12 | ||||
-rw-r--r-- | c++/src/H5VarLenType.h | 15 |
30 files changed, 191 insertions, 121 deletions
diff --git a/c++/src/H5AbstractDs.h b/c++/src/H5AbstractDs.h index eaa9d14..547485c 100644 --- a/c++/src/H5AbstractDs.h +++ b/c++/src/H5AbstractDs.h @@ -33,7 +33,7 @@ class DataSpace; and DataSet. It provides a collection of services that are common to both Attribute - and DataSet. AbstractDs inherits from H5Object. + and DataSet. */ class H5_DLLCPP AbstractDs { public: @@ -91,6 +91,8 @@ class H5_DLLCPP AbstractDs { private: // This member function is implemented by DataSet and Attribute - pure virtual. virtual hid_t p_get_type() const = 0; -}; -} + +}; // end of AbstractDs +} // namespace H5 + #endif // __AbstractDs_H diff --git a/c++/src/H5ArrayType.h b/c++/src/H5ArrayType.h index 82a4e7f..1ba0e5c 100644 --- a/c++/src/H5ArrayType.h +++ b/c++/src/H5ArrayType.h @@ -18,10 +18,11 @@ #define __H5ArrayType_H namespace H5 { - /*! \class ArrayType \brief Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes. + + Inheritance: DataType -> H5Object -> H5Location -> IdComponent */ class H5_DLLCPP ArrayType : public DataType { public: @@ -54,6 +55,8 @@ class H5_DLLCPP ArrayType : public DataType { // Default constructor ArrayType(); -}; -} + +}; // end of ArrayType +} // namespace H5 + #endif // __H5ArrayType_H diff --git a/c++/src/H5AtomType.h b/c++/src/H5AtomType.h index 1851a57..ca48b92 100644 --- a/c++/src/H5AtomType.h +++ b/c++/src/H5AtomType.h @@ -18,13 +18,14 @@ #define __H5AtomType_H namespace H5 { - /*! \class AtomType \brief AtomType is a base class, inherited by IntType, FloatType, StrType, and PredType. AtomType provides operations on HDF5 atomic datatypes. It also inherits from DataType. + + Inheritance: DataType -> H5Object -> H5Location -> IdComponent */ class H5_DLLCPP AtomType : public DataType { public: @@ -76,6 +77,8 @@ class H5_DLLCPP AtomType : public DataType { // Constructor that takes an existing id AtomType( const hid_t existing_id ); #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} + +}; // end of AtomType +} // namespace H5 + #endif // __H5AtomType_H diff --git a/c++/src/H5Attribute.h b/c++/src/H5Attribute.h index 1a45154..4f933e9 100644 --- a/c++/src/H5Attribute.h +++ b/c++/src/H5Attribute.h @@ -18,7 +18,6 @@ #define __H5Attribute_H namespace H5 { - /*! \class Attribute \brief Class Attribute operates on HDF5 attributes. @@ -26,6 +25,8 @@ namespace H5 { Attribute and DataSet are derivatives of AbstractDs. Attribute also inherits from IdComponent because an attribute is an HDF5 component that is identified by an identifier. + + Inheritance: multiple IdComponent/AbstractDs */ class H5_DLLCPP Attribute : public AbstractDs, public IdComponent { public: @@ -112,6 +113,7 @@ class H5_DLLCPP Attribute : public AbstractDs, public IdComponent { // Friend function to set Attribute id. For library use only. friend void f_Attribute_setId(Attribute* attr, hid_t new_id); -}; -} +}; // end of Attribute +} // namespace H5 + #endif // __H5Attribute_H diff --git a/c++/src/H5Classes.h b/c++/src/H5Classes.h index 23004b1..6dc24f4 100644 --- a/c++/src/H5Classes.h +++ b/c++/src/H5Classes.h @@ -37,7 +37,6 @@ namespace H5 { class FloatType; class StrType; class CompType; - //class RefType; class AbstractDs; class DataSet; class Group; diff --git a/c++/src/H5CommonFG.cpp b/c++/src/H5CommonFG.cpp index 725ab83..e1c4818 100644 --- a/c++/src/H5CommonFG.cpp +++ b/c++/src/H5CommonFG.cpp @@ -1300,5 +1300,4 @@ void f_DataSet_setId(DataSet* dset, hid_t new_id) #endif // DOXYGEN_SHOULD_SKIP_THIS -} - +} // end namespace diff --git a/c++/src/H5CommonFG.h b/c++/src/H5CommonFG.h index 62c333d..f1a8886 100644 --- a/c++/src/H5CommonFG.h +++ b/c++/src/H5CommonFG.h @@ -169,8 +169,7 @@ class H5_DLLCPP CommonFG { #endif // DOXYGEN_SHOULD_SKIP_THIS -}; // end of CommonFG declaration +}; // end of CommonFG +} // namespace H5 -} #endif // __CommonFG_H - diff --git a/c++/src/H5CompType.h b/c++/src/H5CompType.h index 581ec79..bc7e114 100644 --- a/c++/src/H5CompType.h +++ b/c++/src/H5CompType.h @@ -18,10 +18,11 @@ #define __H5CompType_H namespace H5 { - /*! \class CompType \brief CompType is a derivative of a DataType and operates on HDF5 compound datatypes. + + Inheritance: DataType -> H5Object -> H5Location -> IdComponent */ class H5_DLLCPP CompType : public DataType { public: @@ -109,6 +110,8 @@ class H5_DLLCPP CompType : public DataType { // Contains common code that is used by the member functions // getMemberXxxType hid_t p_get_member_type(unsigned member_num) const; -}; -} + +}; // end of CompType +} // namespace H5 + #endif // __H5CompType_H diff --git a/c++/src/H5DataSet.h b/c++/src/H5DataSet.h index a424b21..049ca48 100644 --- a/c++/src/H5DataSet.h +++ b/c++/src/H5DataSet.h @@ -18,13 +18,14 @@ #define __H5DataSet_H namespace H5 { - /*! \class DataSet \brief Class DataSet operates on HDF5 datasets. An datasets has many characteristics similar to an attribute, thus both Attribute and DataSet are derivatives of AbstractDs. DataSet also inherits from H5Object because a dataset is an HDF5 object. + + Inheritance: multiple H5Object/AbstractDs -> H5Location -> IdComponent */ class H5_DLLCPP DataSet : public H5Object, public AbstractDs { public: @@ -128,6 +129,7 @@ class H5_DLLCPP DataSet : public H5Object, public AbstractDs { // Friend function to set DataSet id. For library use only. friend void f_DataSet_setId(DataSet* dset, hid_t new_id); -}; -} +}; // end of DataSet +} // namespace H5 + #endif // __H5DataSet_H diff --git a/c++/src/H5DataSpace.h b/c++/src/H5DataSpace.h index a51266b..fc9c54e 100644 --- a/c++/src/H5DataSpace.h +++ b/c++/src/H5DataSpace.h @@ -18,8 +18,12 @@ #define __H5DataSpace_H namespace H5 { +/*! \class DataSpace + \brief Class DataSpace inherits from IdComponent and provides wrappers for + the HDF5's dataspaces. -//! Class DataSpace operates on HDF5 dataspaces. + Inheritance: IdComponent +*/ class H5_DLLCPP DataSpace : public IdComponent { public: ///\brief Default DataSpace objects @@ -144,6 +148,8 @@ class H5_DLLCPP DataSpace : public IdComponent { friend void f_DataSpace_setId(DataSpace *dspace, hid_t new_id); #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} + +}; // end of DataSpace +} // namespace H5 + #endif // __H5DataSpace_H diff --git a/c++/src/H5DataType.h b/c++/src/H5DataType.h index 69e5c6d..3ae97dc 100644 --- a/c++/src/H5DataType.h +++ b/c++/src/H5DataType.h @@ -14,20 +14,18 @@ * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -// Class DataType inherits from H5Object and has several subclasses for -// specific HDF5 data types. - #ifndef __H5DataType_H #define __H5DataType_H namespace H5 { - /*! \class DataType \brief Class DataType provides generic operations on HDF5 datatypes. DataType inherits from H5Object because a named datatype is an HDF5 object and is a base class of ArrayType, AtomType, CompType, EnumType, and VarLenType. + + Inheritance: DataType -> H5Object -> H5Location -> IdComponent */ class H5_DLLCPP DataType : public H5Object { public: @@ -141,6 +139,8 @@ class H5_DLLCPP DataType : public H5Object { friend void f_DataType_setId(DataType* dtype, hid_t new_id); void p_commit(hid_t loc_id, const char* name); -}; -} + +}; // end of DataType +} // namespace H5 + #endif // __H5DataType_H diff --git a/c++/src/H5DcreatProp.h b/c++/src/H5DcreatProp.h index 898fba6..ca99ca4 100644 --- a/c++/src/H5DcreatProp.h +++ b/c++/src/H5DcreatProp.h @@ -14,17 +14,15 @@ * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -// Class DSetCreatPropList represents the HDF5 dataset creation property list -// and inherits from PropList. - #ifndef __H5DSCreatPropList_H #define __H5DSCreatPropList_H namespace H5 { - /*! \class DSetCreatPropList - \brief Class DSetCreatPropList represents the dataset creation property - list. + \brief Class DSetCreatPropList inherits from ObjCreatPropList and provides + wrappers for the HDF5 dataset creation property functions. + + Inheritance: ObjCreatPropList -> PropList -> IdComponent */ class H5_DLLCPP DSetCreatPropList : public ObjCreatPropList { public: @@ -140,6 +138,8 @@ class H5_DLLCPP DSetCreatPropList : public ObjCreatPropList { static DSetCreatPropList* getConstant(); #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} + +}; // end of DSetCreatPropList +} // namespace H5 + #endif // __H5DSCreatPropList_H diff --git a/c++/src/H5DxferProp.h b/c++/src/H5DxferProp.h index ad60020..72b64a16 100644 --- a/c++/src/H5DxferProp.h +++ b/c++/src/H5DxferProp.h @@ -14,17 +14,15 @@ * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -// Class DSetMemXferPropList represents the HDF5 dataset transfer property list -// and inherits from PropList. - #ifndef __H5DSetMemXferPropList_H #define __H5DSetMemXferPropList_H namespace H5 { - /*! \class DSetMemXferPropList - \brief Class DSetMemXferPropList represents the dataset memory and - transfer property list. + \brief Class DSetCreatPropList inherits from PropList and provides + wrappers for the HDF5 dataset memory and transfer property list. + + Inheritance: ObjCreatPropList -> PropList -> IdComponent */ class H5_DLLCPP DSetMemXferPropList : public PropList { public: @@ -128,6 +126,8 @@ class H5_DLLCPP DSetMemXferPropList : public PropList { static DSetMemXferPropList* getConstant(); #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} + +}; // end of DSetMemXferPropList +} // namespace H5 + #endif // __H5DSetMemXferPropList_H diff --git a/c++/src/H5EnumType.h b/c++/src/H5EnumType.h index 3430e2a..7f10d15 100644 --- a/c++/src/H5EnumType.h +++ b/c++/src/H5EnumType.h @@ -18,8 +18,12 @@ #define __H5EnumType_H namespace H5 { +/*! \class EnumType + \brief EnumType is a derivative of a DataType and operates on HDF5 + enum datatypes. -//! Class EnumType operates on HDF5 enum datatypes. + Inheritance: DataType -> H5Object -> H5Location -> IdComponent +*/ class H5_DLLCPP EnumType : public DataType { public: @@ -69,6 +73,8 @@ class H5_DLLCPP EnumType : public DataType { EnumType( const EnumType& original ); virtual ~EnumType(); -}; -} + +}; // end of EnumType +} // namespace H5 + #endif // __H5EnumType_H diff --git a/c++/src/H5Exception.h b/c++/src/H5Exception.h index d6cc2ae..e5f4eab 100644 --- a/c++/src/H5Exception.h +++ b/c++/src/H5Exception.h @@ -167,7 +167,8 @@ class H5_DLLCPP IdComponentException : public Exception { IdComponentException(const H5std_string& func_name, const H5std_string& message = DEFAULT_MSG); IdComponentException(); virtual ~IdComponentException() throw(); -}; -} + +}; // end of IdComponentException +} // namespace H5 #endif // __H5Exception_H diff --git a/c++/src/H5FaccProp.h b/c++/src/H5FaccProp.h index a5fa5f2..272bf39 100644 --- a/c++/src/H5FaccProp.h +++ b/c++/src/H5FaccProp.h @@ -14,15 +14,16 @@ * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -// Class FileAccPropList represents the HDF5 file access property list and -// inherits from DataType. - #ifndef __H5FileAccPropList_H #define __H5FileAccPropList_H namespace H5 { +/*! \class FileAccPropList + \brief Class FileAccPropList inherits from PropList and provides + wrappers for the HDF5 file access property list. -//! Class FileAccPropList represents the HDF5 file access property list. + Inheritance: PropList -> IdComponent +*/ class H5_DLLCPP FileAccPropList : public PropList { public: ///\brief Default file access property list. @@ -154,6 +155,7 @@ class H5_DLLCPP FileAccPropList : public PropList { #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} +}; // end of FileAccPropList +} // namespace H5 + #endif // __H5FileAccPropList_H diff --git a/c++/src/H5FcreatProp.h b/c++/src/H5FcreatProp.h index 598af87..02eacbc 100644 --- a/c++/src/H5FcreatProp.h +++ b/c++/src/H5FcreatProp.h @@ -18,8 +18,12 @@ #define __H5FileCreatPropList_H namespace H5 { +/*! \class FileCreatPropList + \brief Class FileCreatPropList inherits from PropList and provides + wrappers for the HDF5 file create property list. -//! Class FileCreatPropList represents the HDF5 file create property list. + Inheritance: PropList -> IdComponent +*/ class H5_DLLCPP FileCreatPropList : public PropList { public: ///\brief Default file creation property list. @@ -84,6 +88,7 @@ class H5_DLLCPP FileCreatPropList : public PropList { #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} +}; // end of FileCreatPropList +} // namespace H5 + #endif // __H5FileCreatPropList_H diff --git a/c++/src/H5File.h b/c++/src/H5File.h index 1904bdb..22bb6c5 100644 --- a/c++/src/H5File.h +++ b/c++/src/H5File.h @@ -18,11 +18,10 @@ #define __H5File_H namespace H5 { - /*! \class H5File \brief Class H5File represents an HDF5 file. - It inherits from H5Location and CommonFG. + Inheritance: CommonFG/H5Location -> IdComponent */ class H5_DLLCPP H5File : public H5Location, public CommonFG { public: @@ -118,6 +117,7 @@ class H5_DLLCPP H5File : public H5Location, public CommonFG { // constructors taking a string or a char* void p_get_file( const char* name, unsigned int flags, const FileCreatPropList& create_plist, const FileAccPropList& access_plist ); -}; -} +}; // end of H5File +} // namespace H5 + #endif // __H5File_H diff --git a/c++/src/H5FloatType.h b/c++/src/H5FloatType.h index 61c590d..a784105 100644 --- a/c++/src/H5FloatType.h +++ b/c++/src/H5FloatType.h @@ -18,8 +18,12 @@ #define __H5FloatType_H namespace H5 { +/*! \class FloatType + \brief FloatType is a derivative of a DataType and operates on HDF5 + floating point datatype. -//! Class FloatType operates on HDF5 floating point datatype. + Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent +*/ class H5_DLLCPP FloatType : public AtomType { public: // Creates a floating-point type using a predefined type. @@ -66,6 +70,8 @@ class H5_DLLCPP FloatType : public AtomType { // Noop destructor. virtual ~FloatType(); -}; -} + +}; // end of FloatType +} // namespace H5 + #endif // __H5FloatType_H diff --git a/c++/src/H5Group.h b/c++/src/H5Group.h index 12f364f..9f789f1 100644 --- a/c++/src/H5Group.h +++ b/c++/src/H5Group.h @@ -18,11 +18,10 @@ #define __H5Group_H namespace H5 { - /*! \class Group \brief Class Group represents an HDF5 group. - It inherits many operations from H5Location and CommonFG. + Inheritance: CommonFG/H5Object -> H5Location -> IdComponent */ class H5_DLLCPP Group : public H5Object, public CommonFG { public: @@ -66,6 +65,7 @@ class H5_DLLCPP Group : public H5Object, public CommonFG { private: hid_t id; // HDF5 group id -}; -} +}; // end of Group +} // namespace H5 + #endif // __H5Group_H diff --git a/c++/src/H5IdComponent.h b/c++/src/H5IdComponent.h index 64684c2..7874af5 100644 --- a/c++/src/H5IdComponent.h +++ b/c++/src/H5IdComponent.h @@ -17,8 +17,6 @@ #ifndef __IdComponent_H #define __IdComponent_H -// IdComponent represents an HDF5 object that has an identifier. - namespace H5 { class DataSpace; @@ -118,6 +116,6 @@ class H5_DLLCPP IdComponent { #endif // DOXYGEN_SHOULD_SKIP_THIS }; // end class IdComponent +} // namespace H5 -} #endif // __IdComponent_H diff --git a/c++/src/H5IntType.h b/c++/src/H5IntType.h index 48ef1ef..355a51b 100644 --- a/c++/src/H5IntType.h +++ b/c++/src/H5IntType.h @@ -18,8 +18,12 @@ #define __H5IntType_H namespace H5 { +/*! \class IntType + \brief IntType is a derivative of a DataType and operates on HDF5 + integer datatype. -//! Class IntType operates on HDF5 integer datatype. + Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent +*/ class H5_DLLCPP IntType : public AtomType { public: // Creates an integer type using a predefined type @@ -48,6 +52,8 @@ class H5_DLLCPP IntType : public AtomType { // Noop destructor. virtual ~IntType(); -}; -} + +}; // end of IntType +} // namespace H5 + #endif // __H5IntType_H diff --git a/c++/src/H5Library.h b/c++/src/H5Library.h index 0a68d34..a93a68b 100644 --- a/c++/src/H5Library.h +++ b/c++/src/H5Library.h @@ -18,7 +18,6 @@ #define __H5Library_H namespace H5 { - /*! \class H5Library \brief Class H5Library operates the HDF5 library globably. @@ -67,6 +66,7 @@ class H5_DLLCPP H5Library { ~H5Library(); #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} +}; // end of H5Library +} // namespace H5 + #endif // __H5Library_H diff --git a/c++/src/H5Location.h b/c++/src/H5Location.h index 1c0f26f..b93c71e 100644 --- a/c++/src/H5Location.h +++ b/c++/src/H5Location.h @@ -20,7 +20,16 @@ #include "H5Classes.h" // constains forward class declarations namespace H5 { +/*! \class H5Location + \brief H5Location is an abstract base class, added in version 1.8.12. + + It provides a collection of wrappers for the C functions that take a + location identifier to specify the HDF5 object. The location identifier + can be either file, group, dataset, attribute, or named datatype. + Wrappers for H5A functions stay in H5Object. + Inheritance: IdComponent +*/ class H5_DLLCPP H5Location; // forward declaration for UserData4Aiterate // Define the operator function pointer for H5Aiterate(). @@ -169,7 +178,7 @@ class H5_DLLCPP H5Location : public IdComponent { // Noop destructor. virtual ~H5Location(); -}; /* end class H5Location */ +}; // end of H5Location +} // namespace H5 -} #endif // __H5Location_H diff --git a/c++/src/H5Object.h b/c++/src/H5Object.h index a30a65f..016f5a2 100644 --- a/c++/src/H5Object.h +++ b/c++/src/H5Object.h @@ -20,27 +20,24 @@ #include "H5Location.h" #include "H5Classes.h" // constains forward class declarations -// H5Object is a baseclass. It has these subclasses: -// Group, DataSet, and DataType. -// DataType, in turn, has several specific datatypes as subclasses. -// Modification: -// Sept 18, 2012: Added class H5Location in between IdComponent and -// H5Object. An H5File now inherits from H5Location. All HDF5 -// wrappers in H5Object are moved up to H5Location. H5Object -// is left mostly empty for future wrappers that are only for -// group, dataset, and named datatype. Note that the reason for -// adding H5Location instead of simply moving H5File to be under -// H5Object is H5File is not an HDF5 object, and renaming H5Object -// to H5Location will risk breaking user applications. -// -BMR -// Apr 2, 2014: Added wrapper getObjName for H5Iget_name namespace H5 { - /*! \class H5Object \brief Class H5Object is a bridge between H5Location and DataSet, DataType, and Group. - All the wrappers in H5Object were moved to H5Location. + Modification: + Sept 18, 2012: Added class H5Location in between IdComponent and + H5Object. An H5File now inherits from H5Location. All HDF5 + wrappers in H5Object are moved up to H5Location. H5Object + is left mostly empty for future wrappers that are only for + group, dataset, and named datatype. Note that the reason for + adding H5Location instead of simply moving H5File to be under + H5Object is H5File is not an HDF5 object, and renaming H5Object + to H5Location will risk breaking user applications. + -BMR + Apr 2, 2014: Added wrapper getObjName for H5Iget_name + + Inheritance: H5Location -> IdComponent */ class H5_DLLCPP H5Object : public H5Location { public: @@ -73,7 +70,7 @@ class H5_DLLCPP H5Object : public H5Location { #endif // DOXYGEN_SHOULD_SKIP_THIS -}; /* end class H5Object */ +}; // end of H5Object +} // namespace H5 -} #endif // __H5Object_H diff --git a/c++/src/H5OcreatProp.h b/c++/src/H5OcreatProp.h index f0235af..c14bb57 100644 --- a/c++/src/H5OcreatProp.h +++ b/c++/src/H5OcreatProp.h @@ -18,8 +18,12 @@ #define __H5ObjCreatPropList_H namespace H5 { +/*! \class ObjCreatPropList + \brief Class ObjCreatPropList inherits from PropList and provides + wrappers for the HDF5 file create property list. -//! Class ObjCreatPropList represents the HDF5 object creation property list. + Inheritance: PropList -> IdComponent +*/ class H5_DLLCPP ObjCreatPropList : public PropList { public: ///\brief Default object creation property list. @@ -67,6 +71,7 @@ class H5_DLLCPP ObjCreatPropList : public PropList { #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} +}; // end of ObjCreatPropList +} // namespace H5 + #endif // __H5ObjCreatPropList_H diff --git a/c++/src/H5PredType.h b/c++/src/H5PredType.h index 9ba5030..447c2b5 100644 --- a/c++/src/H5PredType.h +++ b/c++/src/H5PredType.h @@ -18,13 +18,14 @@ #define __H5PredType_H namespace H5 { - /*! \class PredType \brief Class PredType holds the definition of all the HDF5 predefined datatypes. These types can only be made copy of, not created by H5Tcreate or closed by H5Tclose. They are treated as constants. + + Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent */ class H5_DLLCPP PredType : public AtomType { public: @@ -436,6 +437,7 @@ class H5_DLLCPP PredType : public AtomType { #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} +}; // end of PredType +} // namespace H5 + #endif // __H5PredType_H diff --git a/c++/src/H5PropList.h b/c++/src/H5PropList.h index 1544ba7..6ef43cf 100644 --- a/c++/src/H5PropList.h +++ b/c++/src/H5PropList.h @@ -18,8 +18,13 @@ #define __H5PropList_H namespace H5 { - //! Class PropList provides operations for generic property lists. +/*! \class PropList + \brief Class PropList inherits from IdComponent and provides wrappers for + the HDF5 generic property list. + + Inheritance: IdComponent +*/ class H5_DLLCPP PropList : public IdComponent { public: ///\brief Default property list @@ -129,7 +134,8 @@ class H5_DLLCPP PropList : public IdComponent { friend void f_PropList_setId(PropList* plist, hid_t new_id); #endif // DOXYGEN_SHOULD_SKIP_THIS -}; -} +}; // end of PropList +} // namespace H5 + #endif // __H5PropList_H diff --git a/c++/src/H5StrType.h b/c++/src/H5StrType.h index ad1df8c..4479223 100644 --- a/c++/src/H5StrType.h +++ b/c++/src/H5StrType.h @@ -18,8 +18,12 @@ #define __H5StrType_H namespace H5 { +/*! \class StrType + \brief StrType is a derivative of a DataType and operates on HDF5 + string datatype. -//! Class StrType operates on HDF5 string datatypes. + Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent +*/ class H5_DLLCPP StrType : public AtomType { public: // Creates a string type using a predefined type @@ -60,6 +64,8 @@ class H5_DLLCPP StrType : public AtomType { // Noop destructor. virtual ~StrType(); -}; -} + +}; // end of StrType +} // namespace H5 + #endif // __H5StrType_H diff --git a/c++/src/H5VarLenType.h b/c++/src/H5VarLenType.h index bc4573a..7a2cfc1 100644 --- a/c++/src/H5VarLenType.h +++ b/c++/src/H5VarLenType.h @@ -14,15 +14,16 @@ * access to either file, you may request a copy from help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -// Class VarLenType inherits from DataType and provides wrappers for -// the HDF5 C's Variable-length Datatypes. - #ifndef __H5VarLenType_H #define __H5VarLenType_H namespace H5 { +/*! \class VarLenType + \brief VarLenType is a derivative of a DataType and operates on HDF5 + C's Variable-length Datatypes. -//! VarLenType operates on the HDF5 C's Variable-length Datatypes. + Inheritance: DataType -> H5Object -> H5Location -> IdComponent +*/ class H5_DLLCPP VarLenType : public DataType { public: // Constructor that creates a variable-length datatype based @@ -43,6 +44,8 @@ class H5_DLLCPP VarLenType : public DataType { // Default constructor VarLenType(); -}; -} + +}; // end of VarLenType +} // namespace H5 + #endif // __H5VarLenType_H |