HDF5 C++ API Reference Manual

 

 

 

Main Page | Namespace List | Class Hierarchy | Class List | File List | Class Members | Examples

H5DcreatProp.h

Go to the documentation of this file.
00001 // C++ informative line for the emacs editor: -*- C++ -*- 00002 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 00003 * Copyright by the Board of Trustees of the University of Illinois. * 00004 * All rights reserved. * 00005 * * 00006 * This file is part of HDF5. The full HDF5 copyright notice, including * 00007 * terms governing use, modification, and redistribution, is contained in * 00008 * the files COPYING and Copyright.html. COPYING can be found at the root * 00009 * of the source code distribution tree; Copyright.html can be found at the * 00010 * root level of an installed copy of the electronic HDF5 document set and * 00011 * is linked from the top-level documents page. It can also be found at * 00012 * http://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html. If you do not have * 00013 * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. * 00014 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 00015 00016 #ifndef _H5DSCreatPropList_H 00017 #define _H5DSCreatPropList_H 00018 00019 #ifndef H5_NO_NAMESPACE 00020 namespace H5 { 00021 #endif 00022 00023 class H5_DLLCPP DSetCreatPropList : public PropList { 00024 public: 00025 // Default dataset creation property list. 00026 static const DSetCreatPropList DEFAULT; 00027 00028 // Queries whether all the filters set in this property list are 00029 // available currently. 00030 bool allFiltersAvail(); 00031 00032 // Get space allocation time for this property. 00033 H5D_alloc_time_t getAllocTime(); 00034 00035 // Set space allocation time for dataset during creation. 00036 void setAllocTime(H5D_alloc_time_t alloc_time); 00037 00038 // Retrieves the size of the chunks used to store a chunked layout dataset. 00039 int getChunk( int max_ndims, hsize_t* dim ) const; 00040 00041 // Sets the size of the chunks used to store a chunked layout dataset. 00042 void setChunk( int ndims, const hsize_t* dim ) const; 00043 00044 // Returns information about an external file. 00045 void getExternal( int idx, size_t name_size, char* name, off_t& offset, hsize_t& size ) const; 00046 00047 // Returns the number of external files for a dataset. 00048 int getExternalCount() const; 00049 00050 // Gets fill value writing time. 00051 H5D_fill_time_t getFillTime(); 00052 00053 // Sets fill value writing time for dataset. 00054 void setFillTime(H5D_fill_time_t fill_time); 00055 00056 // Retrieves a dataset fill value. 00057 void getFillValue( const DataType& fvalue_type, void* value ) const; 00058 00059 // Sets a dataset fill value. 00060 void setFillValue( const DataType& fvalue_type, const void* value ) const; 00061 00062 // Returns information about a filter in a pipeline. 00063 H5Z_filter_t getFilter(int filter_number, unsigned int& flags, size_t& cd_nelmts, unsigned int* cd_values, size_t namelen, char name[]) const; 00064 00065 // Returns information about a filter in a pipeline given the filter id. 00066 void getFilterById(H5Z_filter_t filter_id, unsigned int &flags, size_t &cd_nelmts, unsigned int* cd_values, size_t namelen, char name[]) const; 00067 00068 // Gets the layout of the raw data storage of the data that uses this 00069 // property list. 00070 H5D_layout_t getLayout() const; 00071 00072 // Sets the type of storage used to store the raw data for the 00073 // dataset that uses this property list. 00074 void setLayout(H5D_layout_t layout) const; 00075 00076 // Returns the number of filters in the pipeline. 00077 int getNfilters() const; 00078 00079 // Checks if fill value has been defined for this property. 00080 H5D_fill_value_t isFillValueDefined(); 00081 00082 // Modifies the specified filter. 00083 void modifyFilter( H5Z_filter_t filter_id, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] ) const; 00084 00085 // Remove one or all filters from the filter pipeline. 00086 void removeFilter( H5Z_filter_t filter_id) const; 00087 00088 // Sets compression method and compression level. 00089 void setDeflate( int level ) const; 00090 00091 // Adds an external file to the list of external files. 00092 void setExternal( const char* name, off_t offset, hsize_t size ) const; 00093 00094 // Adds a filter to the filter pipeline. 00095 void setFilter( H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int cd_values[] ) const; 00096 00097 // Sets Fletcher32 checksum of EDC for this property list. 00098 void setFletcher32(); 00099 00100 // Sets method of the shuffle filter. 00101 void setShuffle(); 00102 00103 // Default constructor: creates a stub dataset creation property list. 00104 DSetCreatPropList(); 00105 00106 // Copy constructor: creates a copy of a DSetCreatPropList object. 00107 DSetCreatPropList(const DSetCreatPropList& orig); 00108 00109 // Creates a copy of an existing dataset creation property list 00110 // using the property list id. 00111 DSetCreatPropList(const hid_t plist_id); 00112 00113 // Noop destructor. 00114 virtual ~DSetCreatPropList(); 00115 }; 00116 #ifndef H5_NO_NAMESPACE 00117 } 00118 #endif 00119 #endif

Generated on Thu Aug 5 00:22:37 2004 by doxygen 1.3.7-20040718