summaryrefslogtreecommitdiffstats
path: root/c++/src/H5VarLenType.h
diff options
context:
space:
mode:
Diffstat (limited to 'c++/src/H5VarLenType.h')
-rw-r--r--c++/src/H5VarLenType.h51
1 files changed, 26 insertions, 25 deletions
diff --git a/c++/src/H5VarLenType.h b/c++/src/H5VarLenType.h
index ca85f54..1b93876 100644
--- a/c++/src/H5VarLenType.h
+++ b/c++/src/H5VarLenType.h
@@ -6,43 +6,44 @@
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
- * the files COPYING and Copyright.html. COPYING can be found at the root *
- * of the source code distribution tree; Copyright.html can be found at the *
- * root level of an installed copy of the electronic HDF5 document set and *
- * is linked from the top-level documents page. It can also be found at *
- * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
- * access to either file, you may request a copy from help@hdfgroup.org. *
+ * the COPYING file, which can be found at the root of the source code *
+ * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
+ * If you do not have 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 {
-//! VarLenType operates on the HDF5 C's Variable-length Datatypes.
+/*! \class VarLenType
+ \brief VarLenType is a derivative of a DataType and operates on 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
- // on the specified base type.
- VarLenType(const DataType* base_type);
+ // Constructor that creates a variable-length datatype based
+ // on the specified base type.
+ VarLenType(const DataType* base_type);
+
+ ///\brief Returns this class name.
+ virtual H5std_string fromClass () const { return("VarLenType"); }
+
+ // Copy constructor: makes copy of the original object.
+ VarLenType(const VarLenType& original);
- ///\brief Returns this class name.
- virtual H5std_string fromClass () const { return("VarLenType"); }
+ // Constructor that takes an existing id
+ VarLenType(const hid_t existing_id);
- // Copy constructor: makes copy of the original object.
- VarLenType( const VarLenType& original );
+ // Noop destructor
+ virtual ~VarLenType();
- // Constructor that takes an existing id
- VarLenType( const hid_t existing_id );
+ // Default constructor
+ VarLenType();
- // Noop destructor
- virtual ~VarLenType();
+}; // end of VarLenType
+} // namespace H5
- // Default constructor
- VarLenType();
-};
-}
#endif // __H5VarLenType_H