15 #ifndef __H5DSCreatPropList_H
16 #define __H5DSCreatPropList_H
39 bool allFiltersAvail()
const;
42 H5D_alloc_time_t getAllocTime()
const;
45 void setAllocTime(H5D_alloc_time_t alloc_time)
const;
48 int getChunk(
int max_ndims, hsize_t* dim)
const;
51 void setChunk(
int ndims,
const hsize_t* dim)
const;
54 void getExternal(
unsigned idx,
size_t name_size,
char* name, off_t& offset, hsize_t& size)
const;
57 int getExternalCount()
const;
60 H5D_fill_time_t getFillTime()
const;
63 void setFillTime(H5D_fill_time_t fill_time)
const;
66 void getFillValue(
const DataType& fvalue_type,
void* value)
const;
69 void setFillValue(
const DataType& fvalue_type,
const void* value)
const;
72 H5Z_filter_t getFilter(
int filter_number,
unsigned int& flags,
size_t& cd_nelmts,
unsigned int* cd_values,
size_t namelen,
char name[],
unsigned int &filter_config)
const;
75 void getFilterById(H5Z_filter_t filter_id,
unsigned int &flags,
size_t &cd_nelmts,
unsigned int* cd_values,
size_t namelen,
char name[],
unsigned int &filter_config)
const;
79 H5D_layout_t getLayout()
const;
83 void setLayout(H5D_layout_t layout)
const;
86 int getNfilters()
const;
89 H5D_fill_value_t isFillValueDefined()
const;
92 void modifyFilter(H5Z_filter_t filter_id,
unsigned int flags,
size_t cd_nelmts,
const unsigned int cd_values[])
const;
95 void removeFilter(H5Z_filter_t filter_id)
const;
98 void setDeflate(
int level)
const;
101 void setExternal(
const char* name, off_t offset, hsize_t size)
const;
104 void setFilter(H5Z_filter_t filter,
unsigned int flags = 0,
size_t cd_nelmts = 0,
const unsigned int cd_values[] = NULL)
const;
107 void setFletcher32()
const;
110 void setShuffle()
const;
113 void setSzip(
unsigned int options_mask,
unsigned int pixels_per_block)
const;
116 void setNbit()
const;
119 void setVirtual(
const DataSpace& vspace,
const char *src_fname,
const char *src_dsname,
const DataSpace& sspace)
const;
120 void setVirtual(
const DataSpace& vspace,
const H5std_string src_fname,
const H5std_string src_dsname,
const DataSpace& sspace)
const;
123 virtual H5std_string
fromClass ()
const {
return(
"DSetCreatPropList"); }
135 #ifndef DOXYGEN_SHOULD_SKIP_THIS
138 static void deleteConstants();
146 #endif // DOXYGEN_SHOULD_SKIP_THIS
151 #endif // __H5DSCreatPropList_H
virtual H5std_string fromClass() const
Returns this class name.
Definition: H5DcreatProp.h:123
virtual hid_t getId() const
Get the id of this dataspace.
Definition: H5DataSpace.cpp:625
virtual hid_t getId() const
Get the id of this datatype.
Definition: H5DataType.cpp:898
DSetCreatPropList()
Default constructor: creates a stub dataset creation property list.
Definition: H5DcreatProp.cpp:95
Definition: H5Exception.h:130
int getChunk(int max_ndims, hsize_t *dim) const
Retrieves the size of the chunks used to store a chunked layout dataset.
Definition: H5DcreatProp.cpp:146
Class DSetCreatPropList inherits from ObjCreatPropList and provides wrappers for the HDF5 dataset cre...
Definition: H5DcreatProp.h:29
void setLayout(H5D_layout_t layout) const
Sets the type of storage used store the raw data for a dataset.
Definition: H5DcreatProp.cpp:167
int getExternalCount() const
Returns the number of external files for a dataset.
Definition: H5DcreatProp.cpp:696
void modifyFilter(H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[]) const
Modifies the specified filter.
Definition: H5DcreatProp.cpp:498
void setAllocTime(H5D_alloc_time_t alloc_time) const
Sets space allocation time for dataset during creation.
Definition: H5DcreatProp.cpp:615
void setExternal(const char *name, off_t offset, hsize_t size) const
Adds an external file to the list of external files.
Definition: H5DcreatProp.cpp:679
Class DataSpace inherits from IdComponent and provides wrappers for the HDF5's dataspaces.
Definition: H5DataSpace.h:25
virtual ~DSetCreatPropList()
Noop destructor.
Definition: H5DcreatProp.cpp:796
void setFillTime(H5D_fill_time_t fill_time) const
Sets fill value writing time for dataset.
Definition: H5DcreatProp.cpp:636
void setNbit() const
Sets up for the use of the Nbit compression filter.
Definition: H5DcreatProp.cpp:264
void setVirtual(const DataSpace &vspace, const char *src_fname, const char *src_dsname, const DataSpace &sspace) const
Maps elements of a virtual dataset to elements of the source dataset.
Definition: H5DcreatProp.cpp:758
bool allFiltersAvail() const
Queries whether all the filters set in this property list are available currently.
Definition: H5DcreatProp.cpp:518
void removeFilter(H5Z_filter_t filter_id) const
Removes one or more filters.
Definition: H5DcreatProp.cpp:388
void getExternal(unsigned idx, size_t name_size, char *name, off_t &offset, hsize_t &size) const
Returns information about an external file.
Definition: H5DcreatProp.cpp:730
H5D_fill_value_t isFillValueDefined() const
Check if fill value has been defined for this property.
Definition: H5DcreatProp.cpp:334
void setShuffle() const
Sets method of the shuffle filter.
Definition: H5DcreatProp.cpp:541
void setFletcher32() const
Sets Fletcher32 checksum of EDC for this property list.
Definition: H5DcreatProp.cpp:653
void getFilterById(H5Z_filter_t filter_id, unsigned int &flags, size_t &cd_nelmts, unsigned int *cd_values, size_t namelen, char name[], unsigned int &filter_config) const
Returns information about a filter in a pipeline given the filter id.
Definition: H5DcreatProp.cpp:466
void setSzip(unsigned int options_mask, unsigned int pixels_per_block) const
Sets up for the use of the SZIP compression filter.
Definition: H5DcreatProp.cpp:242
H5D_alloc_time_t getAllocTime() const
Get space allocation time for this property.
Definition: H5DcreatProp.cpp:565
void getFillValue(const DataType &fvalue_type, void *value) const
Retrieves a dataset fill value.
Definition: H5DcreatProp.cpp:314
void setFillValue(const DataType &fvalue_type, const void *value) const
Sets a dataset fill value.
Definition: H5DcreatProp.cpp:291
Definition: H5AbstractDs.cpp:34
int getNfilters() const
Returns the number of filters in the pipeline.
Definition: H5DcreatProp.cpp:405
void setDeflate(int level) const
Sets compression method and compression level.
Definition: H5DcreatProp.cpp:216
H5Z_filter_t getFilter(int filter_number, unsigned int &flags, size_t &cd_nelmts, unsigned int *cd_values, size_t namelen, char name[], unsigned int &filter_config) const
Returns information about a filter in a pipeline.
Definition: H5DcreatProp.cpp:437
H5D_layout_t getLayout() const
Retrieves the layout type of this property list.
Definition: H5DcreatProp.cpp:193
static const DSetCreatPropList & DEFAULT
Default dataset creation property list.
Definition: H5DcreatProp.h:32
Class DataType provides generic operations on HDF5 datatypes.
Definition: H5DataType.h:28
void setFilter(H5Z_filter_t filter, unsigned int flags=0, size_t cd_nelmts=0, const unsigned int cd_values[]=NULL) const
Adds a filter to the filter pipeline.
Definition: H5DcreatProp.cpp:367
H5D_fill_time_t getFillTime() const
Gets fill value writing time.
Definition: H5DcreatProp.cpp:589
Class ObjCreatPropList inherits from PropList and provides wrappers for the HDF5 object create proper...
Definition: H5OcreatProp.h:25
void setChunk(int ndims, const hsize_t *dim) const
Sets the size of the chunks used to store a chunked layout dataset.
Definition: H5DcreatProp.cpp:128
The HDF Group Help Desk:
| |
Copyright by
The HDF Group
and the Board of Trustees of the University of Illinois
|