HDF5 C++ API  1.10.1
 All Classes Namespaces Functions Variables Typedefs Friends Pages
H5CommonFG.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://support.hdfgroup.org/ftp/HDF5/releases. *
11  * If you do not have access to either file, you may request a copy from *
12  * help@hdfgroup.org. *
13  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
14 
15 #ifndef __CommonFG_H
16 #define __CommonFG_H
17 
18 namespace H5 {
19 
20 // Class forwarding
21 class Group;
22 class H5File;
23 class ArrayType;
24 class VarLenType;
25 
30 class H5_DLLCPP CommonFG {
31  public:
32  // Opens a generic named datatype in this location.
33  DataType openDataType(const char* name) const;
34  DataType openDataType(const H5std_string& name) const;
35 
36  // Opens a named array datatype in this location.
37  ArrayType openArrayType(const char* name) const;
38  ArrayType openArrayType(const H5std_string& name) const;
39 
40  // Opens a named compound datatype in this location.
41  CompType openCompType(const char* name) const;
42  CompType openCompType(const H5std_string& name) const;
43 
44  // Opens a named enumeration datatype in this location.
45  EnumType openEnumType(const char* name) const;
46  EnumType openEnumType(const H5std_string& name) const;
47 
48  // Opens a named integer datatype in this location.
49  IntType openIntType(const char* name) const;
50  IntType openIntType(const H5std_string& name) const;
51 
52  // Opens a named floating-point datatype in this location.
53  FloatType openFloatType(const char* name) const;
54  FloatType openFloatType(const H5std_string& name) const;
55 
56  // Opens a named string datatype in this location.
57  StrType openStrType(const char* name) const;
58  StrType openStrType(const H5std_string& name) const;
59 
60  // Opens a named variable length datatype in this location.
61  VarLenType openVarLenType(const char* name) const;
62  VarLenType openVarLenType(const H5std_string& name) const;
63 
64 #ifndef DOXYGEN_SHOULD_SKIP_THIS
65  virtual hid_t getLocId() const = 0;
68 
69 
71  virtual void throwException(const H5std_string& func_name, const H5std_string& msg) const = 0;
72 
73  // Default constructor.
74  CommonFG();
75 
76  // Noop destructor.
77  virtual ~CommonFG();
78 
79  protected:
80  virtual void p_setId(const hid_t new_id) = 0;
81 
82 #endif // DOXYGEN_SHOULD_SKIP_THIS
83 
84 }; // end of CommonFG
85 } // namespace H5
86 
87 #endif // __CommonFG_H
88 
EnumType is derived from a DataType and operates on HDF5 enum datatypes.
Definition: H5EnumType.h:25
IntType is derived from a DataType and operates on HDF5 integer datatype.
Definition: H5IntType.h:25
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
VarLenType is derived from a DataType and operates on HDF5 C's Variable-length Datatypes.
Definition: H5VarLenType.h:25
Class ArrayType inherits from DataType and provides wrappers for the HDF5's Array Datatypes...
Definition: H5ArrayType.h:25
FloatType is a derivative of a DataType and operates on HDF5 floating point datatype.
Definition: H5FloatType.h:25
StrType is derived from a DataType and operates on HDF5 string datatype.
Definition: H5StrType.h:25
CompType is a derivative of a DataType and operates on HDF5 compound datatypes.
Definition: H5CompType.h:25
CommonFG will be deprecated in future releases. In 1.10.1, most member functions are moved to H5Locat...
Definition: H5CommonFG.h:30


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