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::FileCreatPropList Class Reference

Class FileCreatPropList inherits from PropList and provides wrappers for the HDF5 file create property list.

#include <H5FcreatProp.h>

Inheritance diagram for H5::FileCreatPropList:
H5::PropList H5::IdComponent

Public Member Functions

 FileCreatPropList ()
 Default constructor: Creates a file create property list. More...
 
void getVersion (unsigned &super, unsigned &freelist, unsigned &stab, unsigned &shhdr) const
 Retrieves version information for various parts of a file. More...
 
void setUserblock (hsize_t size) const
 Sets the user block size field of this file creation property list. More...
 
hsize_t getUserblock () const
 Returns the user block size of this file creation property list. More...
 
void getSizes (size_t &sizeof_addr, size_t &sizeof_size) const
 Retrieves the size of the offsets and lengths used in an HDF5 file. More...
 
void setSizes (size_t sizeof_addr=4, size_t sizeof_size=4) const
 Sets the byte size of the offsets and lengths used to address objects in an HDF5 file. More...
 
void getSymk (unsigned &int_nodes_k, unsigned &leaf_nodes_k) const
 Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. More...
 
void setSymk (unsigned int_nodes_k, unsigned leaf_nodes_k) const
 Sets the size of parameters used to control the symbol table nodes. More...
 
unsigned getIstorek () const
 Returns the 1/2 rank of an indexed storage B-tree. More...
 
void setIstorek (unsigned ik) const
 Sets the size of the parameter used to control the B-trees for indexing chunked datasets. More...
 
void setFileSpaceStrategy (H5F_fspace_strategy_t strategy, hbool_t persist, hsize_t threshold) const
 Sets the strategy and the threshold value that the library will employ in managing file space. More...
 
void getFileSpaceStrategy (H5F_fspace_strategy_t &strategy, hbool_t &persist, hsize_t &threshold) const
 Retrieves the strategy, persist, and threshold that the library uses in managing file space. More...
 
void setFileSpacePagesize (hsize_t fsp_psize) const
 Sets the file space page size for paged aggregation. More...
 
hsize_t getFileSpacePagesize () const
 Returns the file space page size for aggregating small metadata or raw data. More...
 
virtual H5std_string fromClass () const
 Returns this class name. More...
 
 FileCreatPropList (const FileCreatPropList &orig)
 Copy constructor: makes a copy of the original FileCreatPropList object. More...
 
 FileCreatPropList (const hid_t plist_id)
 Creates a file creation property list using the id of an existing one. More...
 
virtual ~FileCreatPropList ()
 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 FileCreatPropListDEFAULT
 Default file 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::FileCreatPropList::FileCreatPropList ( )
H5::FileCreatPropList::FileCreatPropList ( const FileCreatPropList original)
Parameters
original- IN: FileCreatPropList instance to copy
H5::FileCreatPropList::FileCreatPropList ( const hid_t  plist_id)
Parameters
plist_id- IN: FileCreatPropList id to use
H5::FileCreatPropList::~FileCreatPropList ( )
virtual

Member Function Documentation

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

Reimplemented from H5::PropList.

hsize_t H5::FileCreatPropList::getFileSpacePagesize ( ) const
Returns
File space page size
Exceptions
H5::PropListIException
void H5::FileCreatPropList::getFileSpaceStrategy ( H5F_fspace_strategy_t &  strategy,
hbool_t &  persist,
hsize_t &  threshold 
) const
Parameters
strategy- OUT: Strategy for file space management
persist- OUT: Whether to persist free-space
threshold- OUT: Free-space section threshold
Exceptions
H5::PropListIException
unsigned H5::FileCreatPropList::getIstorek ( ) const
Returns
1/2 rank of chunked storage B-tree
Exceptions
H5::PropListIException
Description
For information, please see http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-GetIstoreK
void H5::FileCreatPropList::getSizes ( size_t &  sizeof_addr,
size_t &  sizeof_size 
) const
void H5::FileCreatPropList::getSymk ( unsigned &  ik,
unsigned &  lk 
) const
hsize_t H5::FileCreatPropList::getUserblock ( ) const
Returns
User block size
Exceptions
H5::PropListIException
void H5::FileCreatPropList::getVersion ( unsigned &  super,
unsigned &  freelist,
unsigned &  stab,
unsigned &  shhdr 
) const
Parameters
super- OUT: The file super block.
freelist- OUT: The global free list.
stab- OUT: The root symbol table entry.
shhdr- OUT: Shared object headers.
Exceptions
H5::PropListIException
Description
Any (or even all) of the output arguments can be null pointers.
void H5::FileCreatPropList::setFileSpacePagesize ( hsize_t  fsp_psize) const
Parameters
fsp_psize- IN: Filespace's page size
Exceptions
H5::PropListIException
void H5::FileCreatPropList::setFileSpaceStrategy ( H5F_fspace_strategy_t  strategy,
hbool_t  persist,
hsize_t  threshold 
) const
Parameters
strategy- IN: Strategy for file space management
persist- IN: Whether to persist free-space
threshold- IN: Free-space section threshold. The library default is 1, which is to track all free-space sections.
Exceptions
H5::PropListIException
Description
If the given strategy is zero, the property will not be changed and the existing strategy will be retained. If the given threshold value is zero, the property will not be changed and the existing threshold will be retained. For information, please see the C layer Reference Manual at: https://support.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetFileSpace
void H5::FileCreatPropList::setIstorek ( unsigned  ik) const
Parameters
ik- IN: 1/2 rank of chunked storage B-tree
Exceptions
H5::PropListIException
Description
For information, please see the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetIstoreK
void H5::FileCreatPropList::setSizes ( size_t  sizeof_addr = 4,
size_t  sizeof_size = 4 
) const
Parameters
sizeof_addr- IN: Size of an object offset in bytes
sizeof_size- IN: Size of an object length in bytes.
Exceptions
H5::PropListIException
Description
For information on setting sizes, please refer to the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSizes
void H5::FileCreatPropList::setSymk ( unsigned  ik,
unsigned  lk 
) const
Parameters
ik- IN: Symbol table tree rank
lk- IN: Symbol table node size
Exceptions
H5::PropListIException
Description
For information, please see the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetSymK
void H5::FileCreatPropList::setUserblock ( hsize_t  size) const
Parameters
size- IN: User block size to be set, in bytes
Exceptions
H5::PropListIException
Description
The default user block size is 0; it may be set to any power of 2 equal to 512 or greater (512, 1024, 2048, etc.)

Member Data Documentation

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