My Project  1.10.4
H5PropList.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 __H5PropList_H
16 #define __H5PropList_H
17 
18 namespace H5 {
19 
24 // Inheritance: IdComponent
25 class H5_DLLCPP PropList : public IdComponent {
26  public:
28  static const PropList& DEFAULT;
29 
30  // Creates a property list of a given type or creates a copy of an
31  // existing property list giving the property list id.
32  PropList(const hid_t plist_id);
33 
34  // Make a copy of the given property list using assignment statement
35  PropList& operator=(const PropList& rhs);
36 
37  // Compares this property list or class against the given list or class.
38  bool operator==(const PropList& rhs) const;
39 
40  // Close this property list.
41  virtual void close();
42 
43  // Close a property list class.
44  void closeClass() const;
45 
46  // Makes a copy of the given property list.
47  void copy(const PropList& like_plist);
48 
49  // Copies a property from this property list or class to another
50  void copyProp(PropList& dest, const char* name) const;
51  void copyProp(PropList& dest, const H5std_string& name) const;
52 
53  // Copies a property from one property list or property class to another
54  void copyProp(PropList& dest, PropList& src, const char* name) const;
55  void copyProp(PropList& dest, PropList& src, const H5std_string& name) const;
56 
57  // Gets the class of this property list, i.e. H5P_FILE_CREATE,
58  // H5P_FILE_ACCESS, ...
59  hid_t getClass() const;
60 
61  // Return the name of a generic property list class.
62  H5std_string getClassName() const;
63 
64  // Returns the parent class of a generic property class.
65  PropList getClassParent() const;
66 
67  // Returns the number of properties in this property list or class.
68  size_t getNumProps() const;
69 
70  // Query the value of a property in a property list.
71  void getProperty(const char* name, void* value) const;
72  void getProperty(const H5std_string& name, void* value) const;
73  H5std_string getProperty(const char* name) const;
74  H5std_string getProperty(const H5std_string& name) const;
75 
76  // Set a property's value in a property list.
77  void setProperty(const char* name, const char* charptr) const;
78  void setProperty(const char* name, const void* value) const;
79  void setProperty(const char* name, const H5std_string& strg) const;
80  void setProperty(const H5std_string& name, const void* value) const;
81  void setProperty(const H5std_string& name, const H5std_string& strg) const;
82  // Deprecated after 1.10.1, missing const
83  void setProperty(const char* name, void* value) const;
84  void setProperty(const char* name, H5std_string& strg) const;
85  void setProperty(const H5std_string& name, void* value) const;
86  void setProperty(const H5std_string& name, H5std_string& strg) const;
87 
88  // Query the size of a property in a property list or class.
89  size_t getPropSize(const char *name) const;
90  size_t getPropSize(const H5std_string& name) const;
91 
92  // Determines whether a property list is a certain class.
93  bool isAClass(const PropList& prop_class) const;
94 
96  bool propExist(const char* name) const;
97  bool propExist(const H5std_string& name) const;
98 
99  // Removes a property from a property list.
100  void removeProp(const char *name) const;
101  void removeProp(const H5std_string& name) const;
102 
104  virtual H5std_string fromClass () const { return("PropList"); }
105 
106  // Default constructor: creates a stub PropList object.
107  PropList();
108 
109  // Copy constructor: same as the original PropList.
110  PropList(const PropList& original);
111 
112  // Gets the property list id.
113  virtual hid_t getId() const;
114 
115  // Destructor: properly terminates access to this property list.
116  virtual ~PropList();
117 
118 #ifndef DOXYGEN_SHOULD_SKIP_THIS
119 
120  // Deletes the PropList global constant
121  static void deleteConstants();
122 
123  protected:
124  hid_t id; // HDF5 property list id
125 
126  // Sets the property list id.
127  virtual void p_setId(const hid_t new_id);
128 
129  private:
130  static PropList* DEFAULT_;
131 
132  // Dynamically allocates the PropList global constant
133  static PropList* getConstant();
134 
135  // Friend function to set PropList id. For library use only.
136  friend void f_PropList_setId(PropList* plist, hid_t new_id);
137 
138 #endif // DOXYGEN_SHOULD_SKIP_THIS
139 
140 }; // end of PropList
141 } // namespace H5
142 
143 #endif // __H5PropList_H
H5::PropList::getNumProps
size_t getNumProps() const
Returns the number of properties in this property list or class.
Definition: H5PropList.cpp:567
H5::Exception
Exception provides wrappers of HDF5 error handling functions.
Definition: H5Exception.h:32
H5::PropList::propExist
bool propExist(const char *name) const
Query the existence of a property in a property object.
Definition: H5PropList.cpp:376
H5::PropListIException
Definition: H5Exception.h:130
H5::PropList::closeClass
void closeClass() const
Close a property list class.
Definition: H5PropList.cpp:414
H5::IdComponent::incRefCount
void incRefCount() const
Increment reference counter for the id of this object.
Definition: H5IdComponent.cpp:53
H5::PropList::~PropList
virtual ~PropList()
Properly terminates access to this property list.
Definition: H5PropList.cpp:813
H5::PropList::fromClass
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5PropList.h:104
H5::PropList::getPropSize
size_t getPropSize(const char *name) const
Query the size of a property in a property list or class.
Definition: H5PropList.cpp:516
H5::PropList::removeProp
void removeProp(const char *name) const
Removes a property from a property list.
Definition: H5PropList.cpp:741
H5::PropList::operator=
PropList & operator=(const PropList &rhs)
Assignment operator.
Definition: H5PropList.cpp:205
H5::PropList::operator==
bool operator==(const PropList &rhs) const
Compares this property list or class against the given list or class.
Definition: H5PropList.cpp:772
H5::Exception::getDetailMsg
H5std_string getDetailMsg() const
Returns the detailed message set at the time the exception is thrown.
Definition: H5Exception.cpp:256
H5::PropList::PropList
PropList()
Default constructor: creates a stub property list object.
Definition: H5PropList.cpp:93
H5::PropList::getProperty
void getProperty(const char *name, void *value) const
Query the value of a property in a property list.
Definition: H5PropList.cpp:435
H5::PropList::DEFAULT
static const PropList & DEFAULT
Default property list.
Definition: H5PropList.h:28
H5::IdComponent
Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier.
Definition: H5IdComponent.h:27
H5::PropList::getClassParent
PropList getClassParent() const
Returns the parent class of a generic property class.
Definition: H5PropList.cpp:792
H5::PropList::getId
virtual hid_t getId() const
Get the id of this property list.
Definition: H5PropList.cpp:292
H5::PropList::getClass
hid_t getClass() const
Returns the class of this property list, i.e. H5P_FILE_CREATE...
Definition: H5PropList.cpp:353
H5
Definition: H5AbstractDs.cpp:34
H5::PropList::getClassName
H5std_string getClassName() const
Return the name of a generic property list class.
Definition: H5PropList.cpp:547
H5::PropList::setProperty
void setProperty(const char *name, const char *charptr) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: H5PropList.cpp:626
H5::PropList::close
virtual void close()
Closes the property list if it is not a default one.
Definition: H5PropList.cpp:332
H5::PropList::copy
void copy(const PropList &like_plist)
Makes a copy of an existing property list.
Definition: H5PropList.cpp:177
H5::PropList
Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.
Definition: H5PropList.h:25
H5::PropList::isAClass
bool isAClass(const PropList &prop_class) const
Determines whether a property list is a certain class.
Definition: H5PropList.cpp:721
H5::PropList::copyProp
void copyProp(PropList &dest, const char *name) const
Copies a property from this property list or class to another.
Definition: H5PropList.cpp:220


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