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


The HDF Group Help Desk:
  Copyright by The HDF Group