summaryrefslogtreecommitdiffstats
path: root/c++/src/H5DataSet.h
diff options
context:
space:
mode:
Diffstat (limited to 'c++/src/H5DataSet.h')
-rw-r--r--c++/src/H5DataSet.h21
1 files changed, 13 insertions, 8 deletions
diff --git a/c++/src/H5DataSet.h b/c++/src/H5DataSet.h
index a3a6a76..92c651c 100644
--- a/c++/src/H5DataSet.h
+++ b/c++/src/H5DataSet.h
@@ -14,8 +14,6 @@
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-// Class DataSet inherits from AbstractDs and provides accesses to a dataset.
-
#ifndef __H5DataSet_H
#define __H5DataSet_H
@@ -23,6 +21,13 @@
namespace H5 {
#endif
+/*! \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.
+*/
class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
public:
// Close this dataset.
@@ -98,6 +103,12 @@ class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
// Destructor: properly terminates access to this dataset.
virtual ~DataSet();
+ protected:
+#ifndef DOXYGEN_SHOULD_SKIP_THIS
+ // Sets the dataset id.
+ virtual void p_setId(const hid_t new_id);
+#endif // DOXYGEN_SHOULD_SKIP_THIS
+
private:
hid_t id; // HDF5 dataset id
@@ -110,12 +121,6 @@ class H5_DLLCPP DataSet : public H5Object, public AbstractDs {
// Reads variable or fixed len strings from this dataset.
void p_read_fixed_len(const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id, const hid_t xfer_plist_id, H5std_string& strg) const;
void p_read_variable_len(const hid_t mem_type_id, const hid_t mem_space_id, const hid_t file_space_id, const hid_t xfer_plist_id, H5std_string& strg) const;
-
- protected:
-#ifndef DOXYGEN_SHOULD_SKIP_THIS
- // Sets the dataset id.
- virtual void p_setId(const hid_t new_id);
-#endif // DOXYGEN_SHOULD_SKIP_THIS
};
#ifndef H5_NO_NAMESPACE
}