bool H5::DSetCreatPropList::allFiltersAvail | ( | ) |
Queries whether all the filters set in this property list are available currently.
H5::PropListIException |
H5D_alloc_time_t H5::DSetCreatPropList::getAllocTime | ( | ) |
Get space allocation time for this property.
H5::PropListIException |
H5D_ALLOC_TIME_DEFAULT
H5D_ALLOC_TIME_EARLY
H5D_ALLOC_TIME_LATE
H5D_ALLOC_TIME_INCR
int H5::DSetCreatPropList::getChunk | ( | int | max_ndims, | |
hsize_t * | dim | |||
) | const |
Retrieves the size of the chunks used to store a chunked layout dataset.
max_ndims | - IN: Size of dim array | |
dim | - OUT: Array to store the chunk dimensions |
H5::PropListIException |
void H5::DSetCreatPropList::getExternal | ( | unsigned | idx, | |
size_t | name_size, | |||
char * | name, | |||
off_t & | offset, | |||
hsize_t & | size | |||
) | const |
Returns information about an external file.
idx | - IN: Index of the external file, ranges [0-(N-1)] and returned by getExternalCount() | |
name_size | - IN: Maximum length of name | |
name | - IN: Name of the external file | |
offset | - IN: Location to return an offset value | |
size | - OUT: Location to return the size of the external file data |
H5::PropListIException |
int H5::DSetCreatPropList::getExternalCount | ( | ) | const |
Returns the number of external files for a dataset.
H5::PropListIException |
H5D_fill_time_t H5::DSetCreatPropList::getFillTime | ( | ) |
Gets fill value writing time.
H5::PropListIException |
H5D_FILL_TIME_NEVER
H5D_FILL_TIME_ALLOC
. void H5::DSetCreatPropList::getFillValue | ( | const DataType & | fvalue_type, | |
void * | value | |||
) | const |
Retrieves a dataset fill value.
fvalue_type | - IN: Data type for the value passed via value | |
value | - OUT: Pointer to buffer to hold the retrieved fill value |
H5::PropListIException |
H5Z_filter_t H5::DSetCreatPropList::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.
filter_number | - IN: Filter to get, range [0..N-1], where N is returned by H5Pget_nfilters() | |
flags | - OUT: General properties of the filter | |
cd_nelmts | - IN/OUT: Number of elements in cd_values /Number of values defined by the filter | |
cd_values | - OUT: Array to hold the data; allocated by the user | |
namelen | - OUT: Length of name | |
name | - OUT: Name of the filter | |
filter_config | - OUT: Flags indicating whether filter can encode/decode |
H5::PropListIException |
void H5::DSetCreatPropList::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.
filter_id | - IN: Filter to get | |
flags | - OUT: General properties of the filter | |
cd_nelmts | - IN/OUT: Number of elements in cd_values /Number of values defined by the filter | |
cd_values | - OUT: Array to hold the data; allocated by the user | |
namelen | - IN: Length of name | |
name | - OUT: Name of the filter | |
filter_config | - OUT: Flags indicating whether filter can encode/decode |
H5::PropListIException |
H5D_layout_t H5::DSetCreatPropList::getLayout | ( | ) | const |
Retrieves the layout type of this property list.
H5D_COMPACT
- raw data is stored in the object header in the file. H5D_CONTIGUOUS
- raw data is stored separately from the object header in one contiguous chunk in the file. H5D_CHUNKED
- raw data is stored separately from the object header in chunks in separate locations in the file. H5::PropListIException |
int H5::DSetCreatPropList::getNfilters | ( | ) | const |
Returns the number of filters in the pipeline.
H5::PropListIException |
H5D_fill_value_t H5::DSetCreatPropList::isFillValueDefined | ( | ) |
Check if fill value has been defined for this property.
H5D_FILL_VALUE_UNDEFINED
=0, H5D_FILL_VALUE_DEFAULT
=1, H5D_FILL_VALUE_USER_DEFINED
=2 H5::PropListIException |
void H5::DSetCreatPropList::modifyFilter | ( | H5Z_filter_t | filter_id, | |
unsigned int | flags, | |||
size_t | cd_nelmts, | |||
const unsigned int | cd_values[] | |||
) | const |
Modifies the specified filter.
filter_id | - IN: Filter to get | |
flags | - OUT: General properties of the filter | |
cd_nelmts | - IN: Number of elements in cd_values OUT: Number of values defined by the filter | |
cd_values | - OUT: Array to hold the data; allocated by the user |
H5::PropListIException |
H5Z_FLAG_OPTIONAL(0x0001)
void H5::DSetCreatPropList::removeFilter | ( | H5Z_filter_t | filter_id | ) | const |
Removes one or more filters.
filter_id | - IN: Filter to remove |
H5::PropListIException |
H5Z_FILTER_NONE
. void H5::DSetCreatPropList::setAllocTime | ( | H5D_alloc_time_t | alloc_time | ) |
Sets space allocation time for dataset during creation.
alloc_time | - IN: Allocation time |
H5::PropListIException |
H5D_ALLOC_TIME_DEFAULT
H5D_ALLOC_TIME_EARLY
H5D_ALLOC_TIME_LATE
H5D_ALLOC_TIME_INCR
void H5::DSetCreatPropList::setChunk | ( | int | ndims, | |
const hsize_t * | dim | |||
) | const |
Sets the size of the chunks used to store a chunked layout dataset.
ndims | - IN: Number of dimensions of each chunk | |
dim | - IN: Array containing the size of each chunk |
H5::PropListIException |
H5D_CHUNKED
, if it is not so already. void H5::DSetCreatPropList::setDeflate | ( | int | level | ) | const |
Sets compression method and compression level.
level | - IN: Compression level, should [0..9], inclusive |
H5::PropListIException |
H5D_COMPRESS_DEFLATE
and the compression level to level. Lower compression levels are faster but result in less compression. void H5::DSetCreatPropList::setExternal | ( | const char * | name, | |
off_t | offset, | |||
hsize_t | size | |||
) | const |
Adds an external file to the list of external files.
name | - IN: Name of the external file | |
offset | - IN: Location where the data starts in the file | |
size | - IN: Number of bytes reserved in the file for the data |
H5::PropListIException |
void H5::DSetCreatPropList::setFillTime | ( | H5D_fill_time_t | fill_time | ) |
Sets fill value writing time for dataset.
H5::PropListIException |
H5D_FILL_TIME_NEVER
H5D_FILL_TIME_ALLOC
. void H5::DSetCreatPropList::setFillValue | ( | const DataType & | fvalue_type, | |
const void * | value | |||
) | const |
Sets a dataset fill value.
fvalue_type | - IN: Data type for the value passed via value | |
value | - IN: Pointer to buffer containing the fill value |
H5::PropListIException |
void H5::DSetCreatPropList::setFilter | ( | H5Z_filter_t | filter_id, | |
unsigned int | flags = 0 , |
|||
size_t | cd_nelmts = 0 , |
|||
const unsigned int | cd_values[] = NULL | |||
) | const |
Adds a filter to the filter pipeline.
filter_id | - IN: Filter to add | |
flags | - IN: Specifies general properties of the filter | |
cd_nelmts | - IN: Number of elements in cd_values | |
cd_values | - IN: Auxiliary data for the filter |
H5::PropListIException |
H5Z_FLAG_OPTIONAL(0x0001)
DataSet::write()
operation then the filter is just excluded from the pipeline for the chunk for which it failed; the filter will not participate in the pipeline during a DataSet::read()
of the chunk. If this bit is clear and the filter fails then the entire I/O operation fails. void H5::DSetCreatPropList::setFletcher32 | ( | ) | const |
Sets Fletcher32 checksum of EDC for this property list.
H5::PropListIException |
void H5::DSetCreatPropList::setLayout | ( | H5D_layout_t | layout | ) | const |
Sets the type of storage used store the raw data for a dataset.
layout | - IN: Type of storage layout for raw data |
H5::PropListIException |
void H5::DSetCreatPropList::setShuffle | ( | ) | const |
Sets method of the shuffle filter.
H5::PropListIException |
H5Pset_shuffle
for details. http://www.hdfgroup.org/HDF5/doc/RM/RM_H5P.html#Property-SetShuffle void H5::DSetCreatPropList::setSzip | ( | unsigned int | options_mask, | |
unsigned int | pixels_per_block | |||
) | const |
Sets up for the use of the SZIP compression filter.
options_mask | - IN: A bit-mask conveying the desired SZIP options. Valid values are H5_SZIP_EC_OPTION_MASK and H5_SZIP_NN_OPTION_MASK. | |
pixels_per_block | - IN: Number of pixels or data elements in each data block. |
H5::PropListIException |