15 #ifndef __H5PropList_H
16 #define __H5PropList_H
38 bool operator==(
const PropList& rhs)
const;
44 void closeClass()
const;
47 void copy(
const PropList& like_plist);
50 void copyProp(
PropList& dest,
const char* name)
const;
51 void copyProp(
PropList& dest,
const H5std_string& name)
const;
55 void copyProp(
PropList& dest,
PropList& src,
const H5std_string& name)
const;
59 hid_t getClass()
const;
62 H5std_string getClassName()
const;
68 size_t getNumProps()
const;
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;
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;
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;
89 size_t getPropSize(
const char *name)
const;
90 size_t getPropSize(
const H5std_string& name)
const;
93 bool isAClass(
const PropList& prop_class)
const;
96 bool propExist(
const char* name)
const;
97 bool propExist(
const H5std_string& name)
const;
100 void removeProp(
const char *name)
const;
101 void removeProp(
const H5std_string& name)
const;
104 virtual H5std_string
fromClass ()
const {
return(
"PropList"); }
113 virtual hid_t getId()
const;
118 #ifndef DOXYGEN_SHOULD_SKIP_THIS
121 static void deleteConstants();
127 virtual void p_setId(
const hid_t new_id);
136 friend void f_PropList_setId(
PropList* plist, hid_t new_id);
138 #endif // DOXYGEN_SHOULD_SKIP_THIS
143 #endif // __H5PropList_H
size_t getNumProps() const
Returns the number of properties in this property list or class.
Definition: H5PropList.cpp:567
Exception provides wrappers of HDF5 error handling functions.
Definition: H5Exception.h:32
bool propExist(const char *name) const
Query the existence of a property in a property object.
Definition: H5PropList.cpp:376
Definition: H5Exception.h:130
void closeClass() const
Close a property list class.
Definition: H5PropList.cpp:414
void incRefCount() const
Increment reference counter for the id of this object.
Definition: H5IdComponent.cpp:53
virtual ~PropList()
Properly terminates access to this property list.
Definition: H5PropList.cpp:813
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5PropList.h:104
size_t getPropSize(const char *name) const
Query the size of a property in a property list or class.
Definition: H5PropList.cpp:516
void removeProp(const char *name) const
Removes a property from a property list.
Definition: H5PropList.cpp:741
PropList & operator=(const PropList &rhs)
Assignment operator.
Definition: H5PropList.cpp:205
bool operator==(const PropList &rhs) const
Compares this property list or class against the given list or class.
Definition: H5PropList.cpp:772
H5std_string getDetailMsg() const
Returns the detailed message set at the time the exception is thrown.
Definition: H5Exception.cpp:256
PropList()
Default constructor: creates a stub property list object.
Definition: H5PropList.cpp:93
void getProperty(const char *name, void *value) const
Query the value of a property in a property list.
Definition: H5PropList.cpp:435
static const PropList & DEFAULT
Default property list.
Definition: H5PropList.h:28
Class IdComponent provides wrappers of the C functions that operate on an HDF5 identifier.
Definition: H5IdComponent.h:27
PropList getClassParent() const
Returns the parent class of a generic property class.
Definition: H5PropList.cpp:792
virtual hid_t getId() const
Get the id of this property list.
Definition: H5PropList.cpp:292
hid_t getClass() const
Returns the class of this property list, i.e. H5P_FILE_CREATE...
Definition: H5PropList.cpp:353
Definition: H5AbstractDs.cpp:34
H5std_string getClassName() const
Return the name of a generic property list class.
Definition: H5PropList.cpp:547
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
virtual void close()
Closes the property list if it is not a default one.
Definition: H5PropList.cpp:332
void copy(const PropList &like_plist)
Makes a copy of an existing property list.
Definition: H5PropList.cpp:177
Class PropList inherits from IdComponent and provides wrappers for the HDF5 generic property list.
Definition: H5PropList.h:25
bool isAClass(const PropList &prop_class) const
Determines whether a property list is a certain class.
Definition: H5PropList.cpp:721
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
|