Class PropList provides operations for generic property lists.
#include <H5PropList.h>
Public Member Functions | |
PropList (const hid_t plist_id) | |
Creates a property list using the id of an existing property. More... | |
PropList & | operator= (const PropList &rhs) |
Assignment operator. More... | |
bool | operator== (const PropList &rhs) const |
Compares this property list or class against the given list or class. More... | |
virtual void | close () |
Closes the property list if it is not a default one. More... | |
void | closeClass () const |
Close a property list class. More... | |
void | copy (const PropList &like_plist) |
Makes a copy of an existing property list. More... | |
void | copyProp (PropList &dest, const char *name) const |
Copies a property from this property list or class to another. More... | |
void | copyProp (PropList &dest, const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
void | copyProp (PropList &dest, PropList &src, const char *name) const |
Copies a property from one list or class to another - Obsolete. More... | |
void | copyProp (PropList &dest, PropList &src, const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. - Obsolete. More... | |
hid_t | getClass () const |
Returns the class of this property list, i.e. H5P_FILE_CREATE ... More... | |
H5std_string | getClassName () const |
Return the name of a generic property list class. More... | |
PropList | getClassParent () const |
Returns the parent class of a generic property class. More... | |
size_t | getNumProps () const |
Returns the number of properties in this property list or class. More... | |
void | getProperty (const char *name, void *value) const |
Query the value of a property in a property list. More... | |
void | getProperty (const H5std_string &name, void *value) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
H5std_string | getProperty (const char *name) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
H5std_string | getProperty (const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
void | setProperty (const char *name, void *value) const |
Set a property's value in a property list. More... | |
void | setProperty (const char *name, const char *charptr) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
void | setProperty (const char *name, H5std_string &strg) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
void | setProperty (const H5std_string &name, void *value) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
void | setProperty (const H5std_string &name, H5std_string &strg) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
size_t | getPropSize (const char *name) const |
Query the size of a property in a property list or class. More... | |
size_t | getPropSize (const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
bool | isAClass (const PropList &prop_class) const |
Determines whether a property list is a certain class. More... | |
bool | propExist (const char *name) const |
Query the existance of a property in a property object. More... | |
bool | propExist (const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
void | removeProp (const char *name) const |
Removes a property from a property list. More... | |
void | removeProp (const H5std_string &name) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what arguments it accepts. More... | |
virtual H5std_string | fromClass () const |
Returns this class name. More... | |
PropList () | |
Default constructor: creates a stub property list object. More... | |
PropList (const PropList &original) | |
Copy constructor. More... | |
virtual hid_t | getId () const |
Get the id of this property list. More... | |
virtual | ~PropList () |
Properly terminates access to this property list. More... | |
Public Member Functions inherited from H5::IdComponent | |
void | incRefCount (const hid_t obj_id) const |
Increment reference counter for a given id. More... | |
void | incRefCount () const |
Increment reference counter for the id of this object. More... | |
void | decRefCount (const hid_t obj_id) const |
Decrement reference counter for a given id. More... | |
void | decRefCount () const |
Decrement reference counter for the id of this object. More... | |
int | getCounter (const hid_t obj_id) const |
Returns the reference counter for a given id. More... | |
int | getCounter () const |
Returns the reference counter for the id of this object. More... | |
H5I_type_t | getHDFObjType () const |
Returns the type of the object. It is an overloaded function of the above function. More... | |
IdComponent & | operator= (const IdComponent &rhs) |
Assignment operator. More... | |
void | setId (const hid_t new_id) |
Sets the identifier of this object to a new value. More... | |
IdComponent (const hid_t h5_id) | |
virtual | ~IdComponent () |
Noop destructor. More... | |
Static Public Attributes | |
static const PropList & | DEFAULT |
Default property list. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from H5::IdComponent | |
static H5I_type_t | getHDFObjType (const hid_t obj_id) |
Given an id, returns the type of the object. More... | |
H5::PropList::PropList | ( | const hid_t | plist_id | ) |
plist_id | - IN: Id of the existing property list |
H5::PropListIException |
H5::PropList::PropList | ( | ) |
H5::PropList::PropList | ( | const PropList & | original | ) |
original | - IN: The original property list to copy |
References H5::IdComponent::incRefCount().
|
virtual |
References close(), and H5::Exception::getDetailMsg().
|
virtual |
H5::PropListIException |
Referenced by copy(), and ~PropList().
void H5::PropList::closeClass | ( | ) | const |
H5::PropListIException |
void H5::PropList::copy | ( | const PropList & | like_plist | ) |
like_plist | - IN: Reference to the existing property list |
H5::PropListIException |
References close(), H5::Exception::getDetailMsg(), and getId().
Referenced by operator=().
void H5::PropList::copyProp | ( | PropList & | dest, |
const char * | name | ||
) | const |
dest | - IN: Destination property list or class |
name | - IN: Name of the property to copy - char pointer |
H5::PropListIException |
References getId().
Referenced by copyProp().
void H5::PropList::copyProp | ( | PropList & | dest, |
const H5std_string & | name | ||
) | const |
dest | - IN: Destination property list or class |
name | - IN: Name of the property to copy - H5std_string |
References copyProp().
dest | - IN: Destination property list or class |
src | - IN: Source property list or class |
name | - IN: Name of the property to copy - char pointer |
H5::PropListIException |
References getId().
dest | - IN: Destination property list or class |
src | - IN: Source property list or class |
name | - IN: Name of the property to copy - H5std_string |
References copyProp().
|
inlinevirtual |
Reimplemented in H5::FileAccPropList, H5::DSetCreatPropList, H5::DSetMemXferPropList, H5::FileCreatPropList, and H5::ObjCreatPropList.
hid_t H5::PropList::getClass | ( | ) | const |
H5P_ROOT
H5::PropListIException |
H5std_string H5::PropList::getClassName | ( | ) | const |
PropList H5::PropList::getClassParent | ( | ) | const |
H5::PropListIException |
|
virtual |
Referenced by H5::DataType::convert(), copy(), copyProp(), H5::H5Location::createAttribute(), H5::CommonFG::createDataSet(), H5::H5File::getVFDHandle(), isAClass(), H5::CommonFG::mount(), H5::H5File::openFile(), operator==(), H5::DataSet::read(), H5::FileAccPropList::setFamily(), H5::FileAccPropList::setSplit(), H5::DataSet::vlenReclaim(), and H5::DataSet::write().
size_t H5::PropList::getNumProps | ( | ) | const |
H5::PropListIException |
void H5::PropList::getProperty | ( | const char * | name, |
void * | value | ||
) | const |
name | - IN: Name of property to query - char pointer |
value | - OUT: Pointer to the buffer for the property value |
H5::PropListIException |
Referenced by getProperty().
void H5::PropList::getProperty | ( | const H5std_string & | name, |
void * | value | ||
) | const |
name | - IN: Name of property to query - H5std_string |
value | - OUT: Pointer to the buffer for the property value |
References getProperty().
H5std_string H5::PropList::getProperty | ( | const char * | name | ) | const |
name | - IN: Name of property to query - char pointer |
H5std_string
. H5::PropListIException |
References getPropSize().
H5std_string H5::PropList::getProperty | ( | const H5std_string & | name | ) | const |
name | - IN: Name of property to query - H5std_string |
H5std_string
. References getProperty().
size_t H5::PropList::getPropSize | ( | const char * | name | ) | const |
name | - IN: Name of property to query |
H5::PropListIException |
Referenced by getProperty(), and getPropSize().
size_t H5::PropList::getPropSize | ( | const H5std_string & | name | ) | const |
name | - IN: Name of property to query - H5std_string |
References getPropSize().
bool H5::PropList::isAClass | ( | const PropList & | prop_class | ) | const |
prop_class | - IN: Property class to query |
H5::PropListIException |
References getId().
rhs | - IN: Reference to the existing property list |
H5::PropListIException |
References copy().
bool H5::PropList::operator== | ( | const PropList & | rhs | ) | const |
rhs | - IN: Reference to the property list to compare |
H5::PropListIException |
References getId().
bool H5::PropList::propExist | ( | const char * | name | ) | const |
name | - IN: Name of property to check for - char pointer |
H5::PropListIException |
Referenced by propExist().
bool H5::PropList::propExist | ( | const H5std_string & | name | ) | const |
name | - IN: Name of property to check for - H5std_string |
References propExist().
void H5::PropList::removeProp | ( | const char * | name | ) | const |
name | - IN: Name of property to remove - char pointer |
H5::PropListIException |
Referenced by removeProp().
void H5::PropList::removeProp | ( | const H5std_string & | name | ) | const |
name | - IN: Name of property to remove - H5std_string |
References removeProp().
void H5::PropList::setProperty | ( | const char * | name, |
void * | value | ||
) | const |
name | - IN: Name of property to set - char pointer |
value | - IN: Void pointer to the value for the property |
H5::PropListIException |
Referenced by setProperty().
void H5::PropList::setProperty | ( | const char * | name, |
const char * | charptr | ||
) | const |
name | - IN: Name of property to set - char pointer |
charptr | - IN: Char pointer to the value for the property |
void H5::PropList::setProperty | ( | const char * | name, |
H5std_string & | strg | ||
) | const |
name | - IN: Name of property to set - char pointer |
strg | - IN: Value for the property is a H5std_string |
References setProperty().
void H5::PropList::setProperty | ( | const H5std_string & | name, |
void * | value | ||
) | const |
name | - IN: Name of property to set - H5std_string |
value | - IN: Void pointer to the value for the property |
References setProperty().
void H5::PropList::setProperty | ( | const H5std_string & | name, |
H5std_string & | strg | ||
) | const |
name | - IN: Name of property to set - H5std_string |
strg | - IN: Value for the property is a H5std_string |
References setProperty().
|
static |
The HDF Group Help Desk: |
Copyright by
The HDF Group
and the Board of Trustees of the University of Illinois |