summaryrefslogtreecommitdiffstats
path: root/c++/src/H5DcreatProp.h
diff options
context:
space:
mode:
authorBinh-Minh Ribler <bmribler@hdfgroup.org>2000-11-14 21:30:12 (GMT)
committerBinh-Minh Ribler <bmribler@hdfgroup.org>2000-11-14 21:30:12 (GMT)
commit92041a68656c59813619ae1f26ed211b7f028e86 (patch)
treeaaa3256c9a9f0adde21570eac9254f7ce00450b1 /c++/src/H5DcreatProp.h
parent36acd5381e3977164e0d6d666f8ce97cc53f9387 (diff)
downloadhdf5-92041a68656c59813619ae1f26ed211b7f028e86.zip
hdf5-92041a68656c59813619ae1f26ed211b7f028e86.tar.gz
hdf5-92041a68656c59813619ae1f26ed211b7f028e86.tar.bz2
[svn-r2897] Purpose:
C++ API for 1.3.x branch Description: The *.C and *.h files named different than those in 1.2.x. They are in the form: 'H5' + classname, or just classname if the classname is already prefixed with 'H5' to avoid ambiguity in documentation context. This version has several hidden bugs fixed and an improvement on the reference counting approach. The classes and their inheritance structure are listed below: --------------------------------------- H5Library Exception RefCounter IdComponent H5File DataSpace H5Object Group AbstractDs DataSet Attribute DataType PredType EnumType CompType AtomType StrType IntType FloatType PropList FileCreatPropList FileAccPropList DSetCreatPropList DSetMemXferPropList --------------------------------------- IdComponent uses RefCounter to keep track of opened objects so proper termination of HDF5 objects can be maintained. Each class has a .h file containing the class declaration and a .C file containing its definition. In addition to the classes files, the following files do not have class information: - H5Cpp.h: header file to be included in user's application - H5Idtemplates.h: contains a template function used by several classes - H5Classes.h: contains forward class declarations - H5CommonFG.*: contains common code used by classes H5File and Group - H5Include.h: contains the hdf5.h header file and the #undef RCSID to work around the problem: multiple defined RcsId - H5Alltypes.h: simply serves as a container to hold the header files of all datatypes to simplify the header file inclusion Platforms: Solaris (arabica) and Linux
Diffstat (limited to 'c++/src/H5DcreatProp.h')
-rw-r--r--c++/src/H5DcreatProp.h73
1 files changed, 73 insertions, 0 deletions
diff --git a/c++/src/H5DcreatProp.h b/c++/src/H5DcreatProp.h
new file mode 100644
index 0000000..5fa67ee
--- /dev/null
+++ b/c++/src/H5DcreatProp.h
@@ -0,0 +1,73 @@
+#ifndef _H5DSCreatPropList_H
+#define _H5DSCreatPropList_H
+
+#ifndef H5_NO_NAMESPACE
+namespace H5 {
+#endif
+
+class DSetCreatPropList : public PropList {
+ public:
+ static const DSetCreatPropList DEFAULT;
+
+ // Creates a dataset creation property list
+ DSetCreatPropList() : PropList( H5P_DATASET_CREATE ) {}
+
+ // Copy constructor: creates a copy of a DSetCreatPropList object;
+ // often used by the compiler when passing by value occurs.
+ DSetCreatPropList( const DSetCreatPropList& orig );
+
+ // Copies a dataset creation property list using assignment statement
+ DSetCreatPropList& operator=( const DSetCreatPropList& rhs );
+
+ // 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( DataType& fvalue_type, const void* value ) const;
+
+ // Retrieves a dataset fill value
+ void getFillValue( 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;
+
+ // 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[] ) 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
+ 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 ) {}
+
+ // Default destructor
+ virtual ~DSetCreatPropList();
+};
+#ifndef H5_NO_NAMESPACE
+}
+#endif
+#endif