Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 1.14.5
API Reference
Loading...
Searching...
No Matches
FileCreatPropList Class Reference

#include <c++/src/H5FcreatProp.h>

Detailed Description

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

+ Inheritance diagram for FileCreatPropList:

Public Member Functions

 FileCreatPropList ()
 
void getVersion (unsigned &super, unsigned &freelist, unsigned &stab, unsigned &shhdr) const
 
void setUserblock (hsize_t size) const
 
hsize_t getUserblock () const
 
void getSizes (size_t &sizeof_addr, size_t &sizeof_size) const
 
void setSizes (size_t sizeof_addr=4, size_t sizeof_size=4) const
 
void getSymk (unsigned &int_nodes_k, unsigned &leaf_nodes_k) const
 
void setSymk (unsigned int_nodes_k, unsigned leaf_nodes_k) const
 
unsigned getIstorek () const
 
void setIstorek (unsigned ik) const
 
void setFileSpaceStrategy (H5F_fspace_strategy_t strategy, hbool_t persist, hsize_t threshold) const
 
void getFileSpaceStrategy (H5F_fspace_strategy_t &strategy, hbool_t &persist, hsize_t &threshold) const
 
void setFileSpacePagesize (hsize_t fsp_psize) const
 
hsize_t getFileSpacePagesize () const
 
virtual H5std_string fromClass () const override
 Returns this class name.
 
 FileCreatPropList (const FileCreatPropList &orig)
 
 FileCreatPropList (const hid_t plist_id)
 
virtual ~FileCreatPropList () override=default
 
- Public Member Functions inherited from PropList
 PropList (const hid_t plist_id)
 
PropListoperator= (const PropList &rhs)
 
bool operator== (const PropList &rhs) const
 
virtual void close () override
 
void closeClass () const
 
void copy (const PropList &like_plist)
 
void copyProp (PropList &dest, const char *name) const
 
void copyProp (PropList &dest, const H5std_string &name) const
 
void copyProp (PropList &dest, PropList &src, const char *name) const
 
void copyProp (PropList &dest, PropList &src, const H5std_string &name) const
 
hid_t getClass () const
 
H5std_string getClassName () const
 
PropList getClassParent () const
 
size_t getNumProps () const
 
void getProperty (const char *name, void *value) const
 
void getProperty (const H5std_string &name, void *value) const
 
H5std_string getProperty (const char *name) const
 
H5std_string getProperty (const H5std_string &name) const
 
void setProperty (const char *name, const char *charptr) const
 
void setProperty (const char *name, const void *value) const
 
void setProperty (const char *name, const H5std_string &strg) const
 
void setProperty (const H5std_string &name, const void *value) const
 
void setProperty (const H5std_string &name, const H5std_string &strg) const
 
void setProperty (const char *name, void *value) const
 
void setProperty (const char *name, H5std_string &strg) const
 
void setProperty (const H5std_string &name, void *value) const
 
void setProperty (const H5std_string &name, H5std_string &strg) const
 
size_t getPropSize (const char *name) const
 
size_t getPropSize (const H5std_string &name) const
 
bool isAClass (const PropList &prop_class) const
 
bool propExist (const char *name) const
 Query the existence of a property in a property object.
 
bool propExist (const H5std_string &name) const
 
void removeProp (const char *name) const
 
void removeProp (const H5std_string &name) const
 
virtual H5std_string fromClass () const override
 Returns this class name.
 
 PropList ()
 
 PropList (const PropList &original)
 
virtual hid_t getId () const override
 
virtual ~PropList () override
 
- Public Member Functions inherited from IdComponent
void incRefCount (const hid_t obj_id) const
 
void incRefCount () const
 
void decRefCount (const hid_t obj_id) const
 
void decRefCount () const
 
int getCounter (const hid_t obj_id) const
 
int getCounter () const
 
H5I_type_t getHDFObjType () const
 
IdComponentoperator= (const IdComponent &rhs)
 
void setId (const hid_t new_id)
 
virtual hid_t getId () const =0
 
virtual void close ()=0
 
H5std_string inMemFunc (const char *func_name) const
 
virtual H5std_string fromClass () const
 Returns this class name.
 
virtual ~IdComponent ()=default
 

Static Public Member Functions

static void deleteConstants ()
 
- Static Public Member Functions inherited from PropList
static void deleteConstants ()
 
- Static Public Member Functions inherited from IdComponent
static H5I_type_t getHDFObjType (const hid_t obj_id)
 
static hsize_t getNumMembers (H5I_type_t type)
 
static bool isValid (hid_t an_id)
 
static bool typeExists (H5I_type_t type)
 

Static Public Attributes

static const FileCreatPropListDEFAULT
 Default file creation property list.
 
- Static Public Attributes inherited from PropList
static const PropListDEFAULT
 Default property list.
 

Additional Inherited Members

- Protected Member Functions inherited from PropList
virtual void p_setId (const hid_t new_id) override
 
- Protected Member Functions inherited from IdComponent
 IdComponent ()
 
H5std_string p_get_file_name () const
 
virtual void p_setId (const hid_t new_id)=0
 
- Static Protected Member Functions inherited from IdComponent
static bool p_valid_id (const hid_t obj_id)
 
- Protected Attributes inherited from PropList
hid_t id
 
- Static Protected Attributes inherited from IdComponent
static bool H5dontAtexit_called
 

Constructor & Destructor Documentation

◆ FileCreatPropList() [1/3]

◆ FileCreatPropList() [2/3]

◆ FileCreatPropList() [3/3]

FileCreatPropList ( const hid_t  plist_id)

◆ ~FileCreatPropList()

virtual ~FileCreatPropList ( )
overridevirtualdefault

Member Function Documentation

◆ deleteConstants()

static void deleteConstants ( )
static

◆ fromClass()

virtual H5std_string fromClass ( ) const
overridevirtual

Returns this class name.

Reimplemented from PropList.

◆ getFileSpacePagesize()

hsize_t getFileSpacePagesize ( ) const

◆ getFileSpaceStrategy()

void getFileSpaceStrategy ( H5F_fspace_strategy_t strategy,
hbool_t persist,
hsize_t threshold 
) const

◆ getIstorek()

unsigned getIstorek ( ) const

◆ getSizes()

void getSizes ( size_t &  sizeof_addr,
size_t &  sizeof_size 
) const

◆ getSymk()

void getSymk ( unsigned &  int_nodes_k,
unsigned &  leaf_nodes_k 
) const

◆ getUserblock()

hsize_t getUserblock ( ) const

◆ getVersion()

void getVersion ( unsigned &  super,
unsigned &  freelist,
unsigned &  stab,
unsigned &  shhdr 
) const

◆ setFileSpacePagesize()

void setFileSpacePagesize ( hsize_t  fsp_psize) const

◆ setFileSpaceStrategy()

void setFileSpaceStrategy ( H5F_fspace_strategy_t  strategy,
hbool_t  persist,
hsize_t  threshold 
) const

◆ setIstorek()

void setIstorek ( unsigned  ik) const

◆ setSizes()

void setSizes ( size_t  sizeof_addr = 4,
size_t  sizeof_size = 4 
) const

◆ setSymk()

void setSymk ( unsigned  int_nodes_k,
unsigned  leaf_nodes_k 
) const

◆ setUserblock()

void setUserblock ( hsize_t  size) const

Field Documentation

◆ DEFAULT

const FileCreatPropList& DEFAULT
static

Default file creation property list.


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