H5LcreatProp.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 // Class LinkCreatPropList represents the HDF5 file access property list and
16 // inherits from DataType.
17 
18 #ifndef __H5LinkCreatPropList_H
19 #define __H5LinkCreatPropList_H
20 
21 namespace H5 {
22 
27 // Inheritance: PropList -> IdComponent
28 class H5_DLLCPP LinkCreatPropList : public PropList {
29  public:
31  static const LinkCreatPropList& DEFAULT;
32 
33  // Creates a file access property list.
35 
37  virtual H5std_string fromClass () const { return("LinkCreatPropList"); }
38 
39  // Copy constructor: same as the original LinkCreatPropList.
40  LinkCreatPropList(const LinkCreatPropList& original);
41 
42  // Creates a copy of an existing file access property list
43  // using the property list id.
44  LinkCreatPropList (const hid_t plist_id);
45 
46  // Sets the character encoding of the string.
47  void setCharEncoding(H5T_cset_t encoding) const;
48 
49  // Gets the character encoding of the string.
50  H5T_cset_t getCharEncoding() const;
51 
52  // Noop destructor
53  virtual ~LinkCreatPropList();
54 
55 #ifndef DOXYGEN_SHOULD_SKIP_THIS
56 
57  // Deletes the global constant, should only be used by the library
58  static void deleteConstants();
59 
60  private:
61  static LinkCreatPropList* DEFAULT_;
62 
63  // Creates the global constant, should only be used by the library
64  static LinkCreatPropList* getConstant();
65 
66 #endif // DOXYGEN_SHOULD_SKIP_THIS
67 
68 }; // end of LinkCreatPropList
69 } // namespace H5
70 
71 #endif // __H5LinkCreatPropList_H
Definition: H5AbstractDs.cpp:34
Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list...
Definition: H5PropList.h:25


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