[svn-r9129] Purpose: Updating documentation
Description:
Updated various function headers for the RM as reviewing progresses.
Rearranged functions in header files for more sensible look of the RM.
Platforms tested:
SunOS 5.7 (arabica)
Linux 2.4 (eirene)
This commit is contained in:
Binh-Minh Ribler
@@ -21,96 +21,96 @@ namespace H5 {
|
||||
#endif
|
||||
|
||||
class H5_DLLCPP DSetCreatPropList : public PropList {
|
||||
public:
|
||||
public:
|
||||
// Default dataset creation property list.
|
||||
static const DSetCreatPropList DEFAULT;
|
||||
|
||||
// Creates a dataset creation property list
|
||||
DSetCreatPropList();
|
||||
|
||||
// Copy constructor: creates a copy of a DSetCreatPropList object;
|
||||
// often used by the compiler when passing by value occurs.
|
||||
DSetCreatPropList( const DSetCreatPropList& orig );
|
||||
|
||||
// Sets the type of storage used to store the raw data for the
|
||||
// dataset that uses this property list
|
||||
void setLayout(hid_t plist, H5D_layout_t layout ) const;
|
||||
|
||||
// Gets the layout of the raw data storage of the data that uses this
|
||||
// property list
|
||||
H5D_layout_t getLayout() const;
|
||||
|
||||
// Sets the size of the chunks used to store a chunked layout dataset.
|
||||
void setChunk( int ndims, const hsize_t* dim ) const;
|
||||
|
||||
// Retrieves the size of the chunks used to store a chunked layout dataset.
|
||||
int getChunk( int max_ndims, hsize_t* dim ) const;
|
||||
|
||||
// Sets compression method and compression level
|
||||
void setDeflate( int level ) const;
|
||||
|
||||
// Sets a dataset fill value
|
||||
void setFillValue( const DataType& fvalue_type, const void* value ) const;
|
||||
|
||||
// Retrieves a dataset fill value
|
||||
void getFillValue( const DataType& fvalue_type, void* value ) const;
|
||||
|
||||
// Checks if fill value has been defined for this property
|
||||
H5D_fill_value_t isFillValueDefined();
|
||||
|
||||
// Adds a filter to the filter pipeline
|
||||
void setFilter( H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] ) const;
|
||||
|
||||
// Remove one or all filters from the filter pipeline
|
||||
void removeFilter( H5Z_filter_t filter_id) const;
|
||||
|
||||
// Returns the number of filters in the pipeline
|
||||
int getNfilters() const;
|
||||
|
||||
// Returns information about a filter in a pipeline
|
||||
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 given the filter id
|
||||
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;
|
||||
|
||||
// Modifies the specified filter
|
||||
void modifyFilter( H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] ) const;
|
||||
|
||||
// Queries whether all the filters set in this property list are
|
||||
// available currently.
|
||||
bool allFiltersAvail();
|
||||
|
||||
// Sets method of the shuffle filter
|
||||
void setShuffle();
|
||||
|
||||
// Get space allocation time for this property
|
||||
// Get space allocation time for this property.
|
||||
H5D_alloc_time_t getAllocTime();
|
||||
|
||||
// Gets fill value writing time
|
||||
H5D_fill_time_t getFillTime();
|
||||
|
||||
// Set space allocation time for dataset during creation
|
||||
// Set space allocation time for dataset during creation.
|
||||
void setAllocTime(H5D_alloc_time_t alloc_time);
|
||||
|
||||
// Sets fill value writing time for dataset
|
||||
void setFillTime(H5D_fill_time_t fill_time);
|
||||
// Retrieves the size of the chunks used to store a chunked layout dataset.
|
||||
int getChunk( int max_ndims, hsize_t* dim ) const;
|
||||
|
||||
// Sets Fletcher32 checksum of EDC for this property list
|
||||
void setFletcher32();
|
||||
// Sets the size of the chunks used to store a chunked layout dataset.
|
||||
void setChunk( int ndims, const hsize_t* dim ) const;
|
||||
|
||||
// Adds an external file to the list of external files
|
||||
void setExternal( const char* name, off_t offset, hsize_t size ) const;
|
||||
|
||||
// Returns the number of external files for a dataset
|
||||
int getExternalCount() const;
|
||||
|
||||
// Returns information about an external file
|
||||
// Returns information about an external file.
|
||||
void getExternal( int idx, size_t name_size, char* name, off_t& offset, hsize_t& size ) const;
|
||||
|
||||
// Creates a copy of an existing dataset creation property list
|
||||
// using the property list id
|
||||
DSetCreatPropList( const hid_t plist_id ) : PropList( plist_id ) {}
|
||||
// Returns the number of external files for a dataset.
|
||||
int getExternalCount() const;
|
||||
|
||||
// Default destructor
|
||||
// Gets fill value writing time.
|
||||
H5D_fill_time_t getFillTime();
|
||||
|
||||
// Sets fill value writing time for dataset.
|
||||
void setFillTime(H5D_fill_time_t fill_time);
|
||||
|
||||
// Retrieves a dataset fill value.
|
||||
void getFillValue( const DataType& fvalue_type, void* value ) const;
|
||||
|
||||
// Sets a dataset fill value.
|
||||
void setFillValue( const DataType& fvalue_type, const void* value ) const;
|
||||
|
||||
// Returns information about a filter in a pipeline.
|
||||
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 given the filter id.
|
||||
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;
|
||||
|
||||
// Gets the layout of the raw data storage of the data that uses this
|
||||
// property list.
|
||||
H5D_layout_t getLayout() const;
|
||||
|
||||
// Sets the type of storage used to store the raw data for the
|
||||
// dataset that uses this property list.
|
||||
void setLayout(H5D_layout_t layout) const;
|
||||
|
||||
// Returns the number of filters in the pipeline.
|
||||
int getNfilters() const;
|
||||
|
||||
// Checks if fill value has been defined for this property.
|
||||
H5D_fill_value_t isFillValueDefined();
|
||||
|
||||
// Modifies the specified filter.
|
||||
void modifyFilter( H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] ) const;
|
||||
|
||||
// Remove one or all filters from the filter pipeline.
|
||||
void removeFilter( H5Z_filter_t filter_id) const;
|
||||
|
||||
// Sets compression method and compression level.
|
||||
void setDeflate( int level ) const;
|
||||
|
||||
// Adds an external file to the list of external files.
|
||||
void setExternal( const char* name, off_t offset, hsize_t size ) const;
|
||||
|
||||
// Adds a filter to the filter pipeline.
|
||||
void setFilter( H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] ) const;
|
||||
|
||||
// Sets Fletcher32 checksum of EDC for this property list.
|
||||
void setFletcher32();
|
||||
|
||||
// Sets method of the shuffle filter.
|
||||
void setShuffle();
|
||||
|
||||
// Default constructor: creates a stub dataset creation property list.
|
||||
DSetCreatPropList();
|
||||
|
||||
// Copy constructor: creates a copy of a DSetCreatPropList object.
|
||||
DSetCreatPropList(const DSetCreatPropList& orig);
|
||||
|
||||
// Creates a copy of an existing dataset creation property list
|
||||
// using the property list id.
|
||||
DSetCreatPropList(const hid_t plist_id);
|
||||
|
||||
// Noop destructor.
|
||||
virtual ~DSetCreatPropList();
|
||||
};
|
||||
#ifndef H5_NO_NAMESPACE
|
||||
|
||||
Reference in New Issue
Block a user