summaryrefslogtreecommitdiffstats
path: root/c++/src/H5DcreatProp.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2004-08-20 04:35:18 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2004-08-20 04:35:18 (GMT)
commit824ba5e2fde476934df42284271c358b14e1a6af (patch)
treecaf62890a1527b0fdc2a77a550c7e11f30c48584 /c++/src/H5DcreatProp.h
parentb142a4144862b22c37c27aa11e2ee519a08ede2f (diff)
downloadhdf5-824ba5e2fde476934df42284271c358b14e1a6af.zip
hdf5-824ba5e2fde476934df42284271c358b14e1a6af.tar.gz
hdf5-824ba5e2fde476934df42284271c358b14e1a6af.tar.bz2
[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)
Diffstat (limited to 'c++/src/H5DcreatProp.h')
-rw-r--r--c++/src/H5DcreatProp.h114
1 files changed, 57 insertions, 57 deletions
diff --git a/c++/src/H5DcreatProp.h b/c++/src/H5DcreatProp.h
index 6ae1b75..15a85e3 100644
--- a/c++/src/H5DcreatProp.h
+++ b/c++/src/H5DcreatProp.h
@@ -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();
+ // Queries whether all the filters set in this property list are
+ // available currently.
+ bool allFiltersAvail();
- // Copy constructor: creates a copy of a DSetCreatPropList object;
- // often used by the compiler when passing by value occurs.
- DSetCreatPropList( const DSetCreatPropList& orig );
+ // Get space allocation time for this property.
+ H5D_alloc_time_t getAllocTime();
- // 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;
+ // Set space allocation time for dataset during creation.
+ void setAllocTime(H5D_alloc_time_t alloc_time);
- // Gets the layout of the raw data storage of the data that uses this
- // property list
- H5D_layout_t getLayout() const;
+ // Retrieves the size of the chunks used to store a chunked layout dataset.
+ int getChunk( int max_ndims, hsize_t* dim ) 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;
+ // Returns information about an external file.
+ void getExternal( int idx, size_t name_size, char* name, off_t& offset, hsize_t& size ) const;
- // Sets compression method and compression level
- void setDeflate( int level ) const;
+ // Returns the number of external files for a dataset.
+ int getExternalCount() const;
- // Sets a dataset fill value
- void setFillValue( const DataType& fvalue_type, const void* value ) const;
+ // Gets fill value writing time.
+ H5D_fill_time_t getFillTime();
- // Retrieves a dataset fill value
- void getFillValue( const DataType& fvalue_type, void* value ) const;
+ // Sets fill value writing time for dataset.
+ void setFillTime(H5D_fill_time_t fill_time);
- // Checks if fill value has been defined for this property
- H5D_fill_value_t isFillValueDefined();
+ // Retrieves a dataset fill value.
+ void getFillValue( const DataType& fvalue_type, void* value ) 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 a dataset fill value.
+ void setFillValue( const DataType& fvalue_type, const void* value ) const;
- // Remove one or all filters from the filter pipeline
- void removeFilter( H5Z_filter_t filter_id) 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 the number of filters in the pipeline
- int getNfilters() 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;
- // 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;
+ // Gets the layout of the raw data storage of the data that uses this
+ // property list.
+ H5D_layout_t getLayout() 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;
+ // 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;
- // Modifies the specified filter
- void modifyFilter( H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] ) const;
+ // Returns the number of filters in the pipeline.
+ int getNfilters() const;
- // Queries whether all the filters set in this property list are
- // available currently.
- bool allFiltersAvail();
+ // Checks if fill value has been defined for this property.
+ H5D_fill_value_t isFillValueDefined();
- // Sets method of the shuffle filter
- void setShuffle();
+ // Modifies the specified filter.
+ void modifyFilter( H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] ) const;
- // Get space allocation time for this property
- H5D_alloc_time_t getAllocTime();
+ // Remove one or all filters from the filter pipeline.
+ void removeFilter( H5Z_filter_t filter_id) const;
- // Gets fill value writing time
- H5D_fill_time_t getFillTime();
+ // Sets compression method and compression level.
+ void setDeflate( int level ) const;
- // Set space allocation time for dataset during creation
- void setAllocTime(H5D_alloc_time_t alloc_time);
+ // Adds an external file to the list of external files.
+ void setExternal( const char* name, off_t offset, hsize_t size ) const;
- // Sets fill value writing time for dataset
- void setFillTime(H5D_fill_time_t fill_time);
+ // 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
+ // Sets Fletcher32 checksum of EDC for this property list.
void setFletcher32();
- // Adds an external file to the list of external files
- void setExternal( const char* name, off_t offset, hsize_t size ) const;
+ // Sets method of the shuffle filter.
+ void setShuffle();
- // Returns the number of external files for a dataset
- int getExternalCount() const;
+ // Default constructor: creates a stub dataset creation property list.
+ DSetCreatPropList();
- // Returns information about an external file
- void getExternal( int idx, size_t name_size, char* name, off_t& offset, hsize_t& size ) const;
+ // 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 ) : PropList( plist_id ) {}
+ // using the property list id.
+ DSetCreatPropList(const hid_t plist_id);
- // Default destructor
+ // Noop destructor.
virtual ~DSetCreatPropList();
};
#ifndef H5_NO_NAMESPACE