HDF5 C++ API Reference Manual

 

 

 

Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Examples

H5PropList.h

Go to the documentation of this file.
00001 // C++ informative line for the emacs editor: -*- C++ -*- 00002 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 00003 * Copyright by the Board of Trustees of the University of Illinois. * 00004 * All rights reserved. * 00005 * * 00006 * This file is part of HDF5. The full HDF5 copyright notice, including * 00007 * terms governing use, modification, and redistribution, is contained in * 00008 * the files COPYING and Copyright.html. COPYING can be found at the root * 00009 * of the source code distribution tree; Copyright.html can be found at the * 00010 * root level of an installed copy of the electronic HDF5 document set and * 00011 * is linked from the top-level documents page. It can also be found at * 00012 * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have * 00013 * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. * 00014 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 00015 00016 #ifndef _H5PropList_H 00017 #define _H5PropList_H 00018 00019 #ifndef H5_NO_NAMESPACE 00020 namespace H5 { 00021 #endif 00022 00023 class H5_DLLCPP PropList : public IdComponent { 00024 public: 00025 // Default property list 00026 static const PropList DEFAULT; 00027 00028 // Creates a property list of a given type or creates a copy of an 00029 // existing property list giving the property list id. 00030 PropList(const hid_t plist_id); 00031 00032 // Make a copy of the given property list using assignment statement 00033 PropList& operator=( const PropList& rhs ); 00034 00035 // Compares this property list or class against the given list or class. 00036 bool operator==(const PropList& rhs) const; 00037 00038 // Close a property list class. 00039 void closeClass() const; 00040 00041 // Makes a copy of the given property list. 00042 void copy( const PropList& like_plist ); 00043 00044 // Copies a property from one property list or property class to another 00045 void copyProp( PropList& dest, PropList& src, const char* name) const; 00046 void copyProp( PropList& dest, PropList& src, const string& name) const; 00047 00048 // Gets the class of this property list, i.e. H5P_FILE_CREATE, 00049 // H5P_FILE_ACCESS, ... 00050 hid_t getClass() const; 00051 00052 // Return the name of a generic property list class. 00053 string getClassName() const; 00054 00055 // Returns the parent class of a generic property class. 00056 PropList getClassParent() const; 00057 00058 // Returns the number of properties in this property list or class. 00059 size_t getNumProps() const; 00060 00061 // Query the value of a property in a property list. 00062 void getProperty(const char* name, void* value) const; 00063 string getProperty(const char* name) const; 00064 void getProperty(const string& name, void* value) const; 00065 string getProperty(const string& name) const; 00066 00067 // Set a property's value in a property list. 00068 void setProperty(const char* name, void* charptr) const; 00069 void setProperty(const char* name, const char* value) const; 00070 void setProperty(const char* name, string& strg) const; 00071 void setProperty(const string& name, void* value) const; 00072 void setProperty(const string& name, string& strg) const; 00073 00074 // Query the size of a property in a property list or class. 00075 size_t getPropSize(const char *name) const; 00076 size_t getPropSize(const string& name) const; 00077 00078 // Determines whether a property list is a certain class. 00079 bool isAClass(const PropList& prop_class) const; 00080 00082 bool propExist(const char* name) const; 00083 bool propExist(const string& name) const; 00084 00085 // Removes a property from a property list. 00086 void removeProp(const char *name) const; 00087 void removeProp(const string& name) const; 00088 00089 // Default constructor: creates a stub PropList object. 00090 PropList(); 00091 00092 // Copy constructor: creates a copy of a PropList object. 00093 PropList(const PropList& original); 00094 00095 // Destructor: properly terminates access to this property list. 00096 virtual ~PropList(); 00097 }; 00098 00099 #ifndef H5_NO_NAMESPACE 00100 } 00101 #endif 00102 #endif // _H5PropList_H

Generated on Sat Aug 21 16:36:48 2004 by doxygen 1.3.7-20040718