HDF5 C++ API  1.10.1
 All Classes Namespaces Functions Variables Typedefs Friends Pages
Public Member Functions | Static Public Attributes | List of all members
H5::ObjCreatPropList Class Reference

Class ObjCreatPropList inherits from PropList and provides wrappers for the HDF5 object create property list.

#include <H5OcreatProp.h>

Inheritance diagram for H5::ObjCreatPropList:
H5::PropList H5::IdComponent H5::DSetCreatPropList

Public Member Functions

 ObjCreatPropList ()
 Creates a file access property list. More...
 
void setAttrPhaseChange (unsigned max_compact=8, unsigned min_dense=6) const
 Sets attribute storage phase change thresholds. More...
 
void getAttrPhaseChange (unsigned &max_compact, unsigned &min_dense) const
 Gets attribute storage phase change thresholds. More...
 
void setAttrCrtOrder (unsigned crt_order_flags) const
 Set the flags for creation order of attributes on an object. More...
 
unsigned getAttrCrtOrder () const
 Returns the flags indicating creation order is tracked/indexed for attributes on an object. More...
 
virtual H5std_string fromClass () const
 Returns this class name. More...
 
 ObjCreatPropList (const ObjCreatPropList &original)
 Copy Constructor: makes a copy of the original. More...
 
 ObjCreatPropList (const hid_t plist_id)
 Creates a file access property list using the id of an existing one. More...
 
virtual ~ObjCreatPropList ()
 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 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...
 
 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...
 
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 ObjCreatPropListDEFAULT
 Default object 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::ObjCreatPropList::ObjCreatPropList ( )
H5::ObjCreatPropList::ObjCreatPropList ( const ObjCreatPropList original)
Parameters
original- IN: ObjCreatPropList instance to copy
H5::ObjCreatPropList::ObjCreatPropList ( const hid_t  plist_id)
H5::ObjCreatPropList::~ObjCreatPropList ( )
virtual

Member Function Documentation

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

Reimplemented from H5::PropList.

Reimplemented in H5::DSetCreatPropList.

unsigned H5::ObjCreatPropList::getAttrCrtOrder ( ) const
Returns
The flags
Exceptions
H5::PropListIException
Description
When no flag is set, i.e. crt_order_flags = 0, attribute creation order is neither tracked not indexed. The C layer Reference Manual at can be found at: https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAttrCreationOrder
void H5::ObjCreatPropList::getAttrPhaseChange ( unsigned &  max_compact,
unsigned &  min_dense 
) const
Parameters
max_compact- OUT: Maximum number of attributes to be stored in compact storage.
min_dense- OUT: Minimum number of attributes to be stored in dense storage.
Exceptions
H5::PropListIException
Description
If max_compact is set to 0, dense storage will be used. For more detail about on attribute storage, please refer to the C layer Reference Manual at: https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetAttrPhaseChange
void H5::ObjCreatPropList::setAttrCrtOrder ( unsigned  crt_order_flags) const
Parameters
crt_order_flags- IN: Flags specifying whether to track and index attribute creation order. Default: No flag set
Exceptions
H5::PropListIException
Description
Valid flags are:
  • H5P_CRT_ORDER_TRACKED - Attribute creation order is tracked
  • H5P_CRT_ORDER_INDEXED - Attribute creation order is indexed (requires H5P_CRT_ORDER_TRACKED). When no flag is set, attribute creation order is neither tracked not indexed. Note that HDF5 currently provides no mechanism to turn on attribute creation order tracking at object creation time and to build the index later. The C layer Reference Manual at can be found at: https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAttrCreationOrder
void H5::ObjCreatPropList::setAttrPhaseChange ( unsigned  max_compact = 8,
unsigned  min_dense = 6 
) const
Parameters
max_compact- IN: Maximum number of attributes to be stored in compact storage. Default to 8
min_dense- IN: Minimum number of attributes to be stored in dense storage. Default to 6
Exceptions
H5::PropListIException
Description
If max_compact is set to 0, dense storage will be used. For more detail about on attribute storage, please refer to the C layer Reference Manual at: https://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetAttrPhaseChange

Member Data Documentation

const ObjCreatPropList& H5::ObjCreatPropList::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