HDF5 C++ API  1.10.1
 All Classes Namespaces Functions Variables Typedefs Friends Pages
H5StrType.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 __H5StrType_H
16 #define __H5StrType_H
17 
18 namespace H5 {
19 
24 // Inheritance: AtomType -> DataType -> H5Object -> H5Location -> IdComponent
25 class H5_DLLCPP StrType : public AtomType {
26  public:
27  // Creates a string type using a predefined type
28  StrType(const PredType& pred_type);
29 
30  // Creates a string type with specified length - may be obsolete
31  StrType(const PredType& pred_type, const size_t& size);
32 
33  // Creates a string type with specified length
34  StrType(const int dummy, const size_t& size);
35 
36  // Gets the string datatype of the specified dataset
37  StrType(const DataSet& dataset);
38 
39  // Constructors that open an HDF5 string datatype, given a location.
40  StrType(const H5Location& loc, const char* name);
41  StrType(const H5Location& loc, const H5std_string& name);
42 
43  // Retrieves the character set type of this string datatype.
44  H5T_cset_t getCset() const;
45 
46  // Sets character set to be used.
47  void setCset(H5T_cset_t cset) const;
48 
49  // Retrieves the string padding method for this string datatype.
50  H5T_str_t getStrpad() const;
51 
52  // Defines the storage mechanism for character strings.
53  void setStrpad(H5T_str_t strpad) const;
54 
56  virtual H5std_string fromClass () const { return("StrType"); }
57 
58  // default constructor
59  StrType();
60 
61  // Creates a string datatype using an existing id
62  StrType(const hid_t existing_id);
63 
64  // Copy constructor - makes a copy of the original object
65  StrType(const StrType& original);
66 
67  // Noop destructor.
68  virtual ~StrType();
69 
70 }; // end of StrType
71 } // namespace H5
72 
73 #endif // __H5StrType_H
Class PredType holds the definition of all the HDF5 predefined datatypes.
Definition: H5PredType.h:28
AtomType is a base class, inherited by IntType, FloatType, StrType, and PredType. ...
Definition: H5AtomType.h:25
H5Location is an abstract base class, added in version 1.8.12.
Definition: H5Location.h:36
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5StrType.h:56
Class DataSet operates on HDF5 datasets.
Definition: H5DataSet.h:28
StrType is derived from a DataType and operates on HDF5 string datatype.
Definition: H5StrType.h:25


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