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

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

Detailed Description

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

+ Inheritance diagram for ObjCreatPropList:

Public Member Functions

 ObjCreatPropList ()
 
void setAttrPhaseChange (unsigned max_compact=8, unsigned min_dense=6) const
 
void getAttrPhaseChange (unsigned &max_compact, unsigned &min_dense) const
 
void setAttrCrtOrder (unsigned crt_order_flags) const
 
unsigned getAttrCrtOrder () const
 
virtual H5std_string fromClass () const override
 Returns this class name.
 
 ObjCreatPropList (const ObjCreatPropList &original)
 
 ObjCreatPropList (const hid_t plist_id)
 
virtual ~ObjCreatPropList () 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 ObjCreatPropListDEFAULT
 Default object 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

◆ ObjCreatPropList() [1/3]

◆ ObjCreatPropList() [2/3]

ObjCreatPropList ( const ObjCreatPropList original)

◆ ObjCreatPropList() [3/3]

ObjCreatPropList ( const hid_t  plist_id)

◆ ~ObjCreatPropList()

virtual ~ObjCreatPropList ( )
overridevirtualdefault

Member Function Documentation

◆ deleteConstants()

static void deleteConstants ( )
static

◆ fromClass()

virtual H5std_string fromClass ( ) const
overridevirtual

Returns this class name.

Reimplemented from PropList.

Reimplemented in DSetCreatPropList.

◆ getAttrCrtOrder()

unsigned getAttrCrtOrder ( ) const

◆ getAttrPhaseChange()

void getAttrPhaseChange ( unsigned &  max_compact,
unsigned &  min_dense 
) const

◆ setAttrCrtOrder()

void setAttrCrtOrder ( unsigned  crt_order_flags) const

◆ setAttrPhaseChange()

void setAttrPhaseChange ( unsigned  max_compact = 8,
unsigned  min_dense = 6 
) const

Field Documentation

◆ DEFAULT

const ObjCreatPropList& DEFAULT
static

Default object creation property list.


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