My Project  1.10.8
H5VarLenType.h
1 // C++ informative line for the emacs editor: -*- C++ -*-
2 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
3  * Copyright by The HDF Group. *
4  * Copyright by the Board of Trustees of the University of Illinois. *
5  * All rights reserved. *
6  * *
7  * This file is part of HDF5. The full HDF5 copyright notice, including *
8  * terms governing use, modification, and redistribution, is contained in *
9  * the COPYING file, which can be found at the root of the source code *
10  * distribution tree, or in https://www.hdfgroup.org/licenses. *
11  * If you do not have access to either file, you may request a copy from *
12  * help@hdfgroup.org. *
13  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
14 
15 #ifndef H5VarLenType_H
16 #define H5VarLenType_H
17 
18 namespace H5 {
19 
24 // Inheritance: DataType -> H5Object -> H5Location -> IdComponent
25 class H5_DLLCPP VarLenType : public DataType {
26  public:
27  // Constructor that creates a variable-length datatype based
28  // on the specified base type.
29  VarLenType(const DataType &base_type);
30 
31  // Deprecated - will be removed after 1.10.2
32  VarLenType(const DataType *base_type);
33 
34  // Returns an VarLenType object via DataType* by decoding the
35  // binary object description of this type.
36  virtual DataType *decode() const;
37 
39  virtual H5std_string
40  fromClass() const
41  {
42  return ("VarLenType");
43  }
44 
45  // Copy constructor: same as the original VarLenType.
46  VarLenType(const VarLenType &original);
47 
48  // Constructor that takes an existing id
49  VarLenType(const hid_t existing_id);
50 
51  // Constructors that open a variable-length datatype, given a location.
52  VarLenType(const H5Location &loc, const char *name);
53  VarLenType(const H5Location &loc, const H5std_string &name);
54 
55  // Noop destructor
56  virtual ~VarLenType();
57 
58  // Default constructor
59  VarLenType();
60 
61 }; // end of VarLenType
62 } // namespace H5
63 
64 #endif // H5VarLenType_H
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
H5Location is an abstract base class, added in version 1.8.12.
Definition: H5Location.h:31
VarLenType is a derivative of a DataType and operates on HDF5 Variable-length Datatypes.
Definition: H5VarLenType.h:25
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5VarLenType.h:40
Definition: H5AbstractDs.cpp:34


The HDF Group Help Desk:
  Copyright by The HDF Group
and the Board of Trustees of the University of Illinois