All Classes Namespaces Functions Variables Typedefs Friends Pages
Public Member Functions | Static Public Attributes | List of all members
H5::LinkCreatPropList Class Reference

Class LinkCreatPropList inherits from PropList and provides wrappers for the HDF5 link creation property list.

#include <H5LcreatProp.h>

Inheritance diagram for H5::LinkCreatPropList:
H5::PropList H5::IdComponent

Public Member Functions

 LinkCreatPropList ()
 Creates a file access property list. More...
 
virtual H5std_string fromClass () const
 Returns this class name. More...
 
 LinkCreatPropList (const LinkCreatPropList &original)
 Copy constructor: same HDF5 object as original. More...
 
 LinkCreatPropList (const hid_t plist_id)
 Creates a file access property list using the id of an existing one. More...
 
void setCreateIntermediateGroup (bool crt_intmd_group) const
 Specifies in property list whether to create missing intermediate groups. More...
 
bool getCreateIntermediateGroup () const
 Determines whether property is set to enable creating missing intermediate groups. More...
 
void setCharEncoding (H5T_cset_t encoding) const
 Sets the character encoding of the string. More...
 
H5T_cset_t getCharEncoding () const
 Gets the character encoding of the string. More...
 
virtual ~LinkCreatPropList ()
 Noop destructor. More...
 
- Public Member Functions inherited from H5::PropList
 PropList (const hid_t plist_id)
 Creates a property list using the id of an existing property. More...
 
PropListoperator= (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, 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, const void *value) const
 Set a property's value in a property list. More...
 
void setProperty (const char *name, const 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, const 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, const 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 char *name, void *value) const
 Deprecated due to missing const in prototype. (1.10.1) More...
 
void setProperty (const char *name, H5std_string &strg) const
 Deprecated due to missing const in prototype. (1.10.1) More...
 
void setProperty (const H5std_string &name, void *value) const
 Deprecated due to missing const in prototype. (1.10.1) More...
 
void setProperty (const H5std_string &name, H5std_string &strg) const
 Deprecated due to missing const in prototype. (1.10.1) 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 existence 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...
 
 PropList ()
 Default constructor: creates a stub property list object. More...
 
 PropList (const PropList &original)
 Copy constructor: same HDF5 object as original. 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...
 
IdComponentoperator= (const IdComponent &rhs)
 Assignment operator. More...
 
void setId (const hid_t new_id)
 Sets the identifier of this object to a new value. More...
 
virtual ~IdComponent ()
 Noop destructor. More...
 

Static Public Attributes

static const LinkCreatPropListDEFAULT
 Default link creation property list. More...
 
- Static Public Attributes inherited from H5::PropList
static const PropListDEFAULT
 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...
 
static hsize_t getNumMembers (H5I_type_t type)
 Returns the number of members of the given type. More...
 
static bool isValid (hid_t an_id)
 Checks if the given ID is valid. More...
 
static bool typeExists (H5I_type_t type)
 Queries if a given type is currently registered with the library. More...
 

Constructor & Destructor Documentation

H5::LinkCreatPropList::LinkCreatPropList ( )
H5::LinkCreatPropList::LinkCreatPropList ( const LinkCreatPropList original)
Parameters
original- IN: LinkCreatPropList instance to copy
H5::LinkCreatPropList::LinkCreatPropList ( const hid_t  plist_id)
H5::LinkCreatPropList::~LinkCreatPropList ( )
virtual

Member Function Documentation

virtual H5std_string H5::LinkCreatPropList::fromClass ( ) const
inlinevirtual

Reimplemented from H5::PropList.

H5T_cset_t H5::LinkCreatPropList::getCharEncoding ( ) const
Returns
The character encoding
Exceptions
H5::PropListIException
bool H5::LinkCreatPropList::getCreateIntermediateGroup ( ) const
Returns
true if creating intermediate groups is enabled, and false, otherwise
Exceptions
H5::PropListIException
void H5::LinkCreatPropList::setCharEncoding ( H5T_cset_t  encoding) const
void H5::LinkCreatPropList::setCreateIntermediateGroup ( bool  crt_intmd_group) const
Parameters
crt_intmd_group- IN: Flag specifying whether to create intermediate groups upon the creation of an object
Exceptions
H5::PropListIException

Member Data Documentation

const LinkCreatPropList& H5::LinkCreatPropList::DEFAULT
static

The documentation for this class was generated from the following files:


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