diff options
| author | Larry Knox <lrknox@hdfgroup.org> | 2009-06-01 18:41:46 (GMT) |
|---|---|---|
| committer | Larry Knox <lrknox@hdfgroup.org> | 2009-06-01 18:41:46 (GMT) |
| commit | c1b0f3075280dd3570a8e7d3896881625533fac4 (patch) | |
| tree | 7418491416ae9f1c57e349c35c7863beea99e53c /doc/html/cpplus_RM/H5DataSet_8h-source.html | |
| parent | afaea70f5db7f6212145ed45429038fbb6c83aba (diff) | |
| download | hdf5-c1b0f3075280dd3570a8e7d3896881625533fac4.zip hdf5-c1b0f3075280dd3570a8e7d3896881625533fac4.tar.gz hdf5-c1b0f3075280dd3570a8e7d3896881625533fac4.tar.bz2 | |
[svn-r16994] Snapshot version 1.8 release 3 (snap0)
Diffstat (limited to 'doc/html/cpplus_RM/H5DataSet_8h-source.html')
| -rw-r--r-- | doc/html/cpplus_RM/H5DataSet_8h-source.html | 259 |
1 files changed, 137 insertions, 122 deletions
diff --git a/doc/html/cpplus_RM/H5DataSet_8h-source.html b/doc/html/cpplus_RM/H5DataSet_8h-source.html index b54bf9d..ffbebae 100644 --- a/doc/html/cpplus_RM/H5DataSet_8h-source.html +++ b/doc/html/cpplus_RM/H5DataSet_8h-source.html @@ -337,128 +337,143 @@ style='font-size:22.0pt'><o:p></o:p></span></b></p> </body> </html> -<!-- Generated by Doxygen 1.3.9.1 --> -<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="examples.html">Examples</a></div> -<h1>H5DataSet.h</h1><a href="H5DataSet_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">// C++ informative line for the emacs editor: -*- C++ -*-</span> -00002 <span class="comment">/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *</span> -00003 <span class="comment"> * Copyright by The HDF Group. *</span> -00004 <span class="comment"> * Copyright by the Board of Trustees of the University of Illinois. *</span> -00005 <span class="comment"> * All rights reserved. *</span> -00006 <span class="comment"> * *</span> -00007 <span class="comment"> * This file is part of HDF5. The full HDF5 copyright notice, including *</span> -00008 <span class="comment"> * terms governing use, modification, and redistribution, is contained in *</span> -00009 <span class="comment"> * the files COPYING and Copyright.html. COPYING can be found at the root *</span> -00010 <span class="comment"> * of the source code distribution tree; Copyright.html can be found at the *</span> -00011 <span class="comment"> * root level of an installed copy of the electronic HDF5 document set and *</span> -00012 <span class="comment"> * is linked from the top-level documents page. It can also be found at *</span> -00013 <span class="comment"> * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *</span> -00014 <span class="comment"> * access to either file, you may request a copy from help@hdfgroup.org. *</span> -00015 <span class="comment"> * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */</span> -00016 -00017 <span class="comment">// Class DataSet inherits from AbstractDs and provides accesses to a dataset.</span> -00018 -00019 <span class="preprocessor">#ifndef _H5DataSet_H</span> -00020 <span class="preprocessor"></span><span class="preprocessor">#define _H5DataSet_H</span> -00021 <span class="preprocessor"></span> -00022 <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span> -00023 <span class="preprocessor"></span><span class="keyword">namespace </span>H5 { -00024 <span class="preprocessor">#endif</span> -00025 <span class="preprocessor"></span> -<a name="l00026"></a><a class="code" href="classH5_1_1DataSet.html">00026</a> <span class="keyword">class </span>H5_DLLCPP DataSet : <span class="keyword">public</span> <a class="code" href="classH5_1_1AbstractDs.html">AbstractDs</a> { -00027 <span class="keyword">public</span>: -00028 <span class="comment">// Close this dataset.</span> -00029 <span class="keyword">virtual</span> <span class="keywordtype">void</span> close(); -00030 -00031 <span class="comment">// Extends the dataset with unlimited dimension.</span> -00032 <span class="keywordtype">void</span> extend( <span class="keyword">const</span> hsize_t* size ) <span class="keyword">const</span>; -00033 -00034 <span class="comment">// Fills a selection in memory with a value</span> -00035 <span class="keywordtype">void</span> fillMemBuf(<span class="keyword">const</span> <span class="keywordtype">void</span> *fill, <a class="code" href="classH5_1_1DataType.html">DataType</a>& fill_type, <span class="keywordtype">void</span> *buf, <a class="code" href="classH5_1_1DataType.html">DataType</a>& buf_type, <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space); -00036 <span class="comment">// Fills a selection in memory with zero</span> -00037 <span class="keywordtype">void</span> fillMemBuf(<span class="keywordtype">void</span> *buf, <a class="code" href="classH5_1_1DataType.html">DataType</a>& buf_type, <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space); -00038 -00039 <span class="comment">// Gets the creation property list of this dataset.</span> -00040 <a class="code" href="classH5_1_1DSetCreatPropList.html">DSetCreatPropList</a> getCreatePlist() <span class="keyword">const</span>; -00041 -00042 <span class="comment">// Returns the address of this dataset in the file.</span> -00043 haddr_t getOffset() <span class="keyword">const</span>; -00044 -00045 <span class="comment">// Gets the dataspace of this dataset.</span> -00046 <span class="keyword">virtual</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a> <a class="code" href="classH5_1_1AbstractDs.html#a8">getSpace</a>() <span class="keyword">const</span>; -00047 -00048 <span class="comment">// Determines whether space has been allocated for a dataset.</span> -00049 <span class="keywordtype">void</span> getSpaceStatus(H5D_space_status_t& status) <span class="keyword">const</span>; -00050 -00051 <span class="comment">// Returns the amount of storage size required for this dataset.</span> -00052 hsize_t <a class="code" href="classH5_1_1AbstractDs.html#a10">getStorageSize</a>() <span class="keyword">const</span>; -00053 -00054 <span class="comment">// Returns the number of bytes required to store VL data.</span> -00055 hsize_t getVlenBufSize( <a class="code" href="classH5_1_1DataType.html">DataType</a>& type, <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space ) <span class="keyword">const</span>; -00056 -00057 <span class="comment">// Reclaims VL datatype memory buffers.</span> -00058 <span class="keyword">static</span> <span class="keywordtype">void</span> vlenReclaim(<span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist, <span class="keywordtype">void</span>* buf ); -00059 <span class="keyword">static</span> <span class="keywordtype">void</span> vlenReclaim(<span class="keywordtype">void</span> *buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = DSetMemXferPropList::DEFAULT); -00060 -00061 <span class="comment">// Reads the data of this dataset and stores it in the provided buffer.</span> -00062 <span class="comment">// The memory and file dataspaces and the transferring property list</span> -00063 <span class="comment">// can be defaults.</span> -00064 <span class="keywordtype">void</span> read( <span class="keywordtype">void</span>* buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& mem_type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& mem_space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& file_space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = DSetMemXferPropList::DEFAULT ) <span class="keyword">const</span>; -00065 <span class="keywordtype">void</span> read( <a class="code" href="H5Exception_8h.html#a0">H5std_string</a>& buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& mem_type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& mem_space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& file_space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = DSetMemXferPropList::DEFAULT ) <span class="keyword">const</span>; -00066 -00067 <span class="comment">// Writes the buffered data to this dataset.</span> -00068 <span class="comment">// The memory and file dataspaces and the transferring property list</span> -00069 <span class="comment">// can be defaults.</span> -00070 <span class="keywordtype">void</span> write( <span class="keyword">const</span> <span class="keywordtype">void</span>* buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& mem_type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& mem_space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& file_space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = DSetMemXferPropList::DEFAULT ) <span class="keyword">const</span>; -00071 <span class="keywordtype">void</span> write( <span class="keyword">const</span> <a class="code" href="H5Exception_8h.html#a0">H5std_string</a>& buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& mem_type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& mem_space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& file_space = DataSpace::ALL, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = DSetMemXferPropList::DEFAULT ) <span class="keyword">const</span>; -00072 -00073 <span class="comment">// Iterates the selected elements in the specified dataspace - not implemented in C++ style yet</span> -00074 <span class="keywordtype">int</span> iterateElems( <span class="keywordtype">void</span>* buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space, H5D_operator_t op, <span class="keywordtype">void</span>* op_data = NULL ); -00075 -00076 <span class="comment">// Retrieves the type of object that an object reference points to.</span> -00077 H5G_obj_t getObjType(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type = H5R_OBJECT) <span class="keyword">const</span>; -00078 -00079 <span class="comment">// Retrieves a dataspace with the region pointed to selected.</span> -00080 <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a> getRegion(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type = H5R_DATASET_REGION) <span class="keyword">const</span>; -00081 -00082 <span class="comment">// Creates a reference to a named Hdf5 object or to a dataset region</span> -00083 <span class="comment">// in this object.</span> -00084 <span class="keywordtype">void</span>* Reference(<span class="keyword">const</span> <span class="keywordtype">char</span>* name, <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& dataspace, H5R_type_t ref_type = H5R_DATASET_REGION) <span class="keyword">const</span>; -00085 -00086 <span class="comment">// Creates a reference to a named Hdf5 object in this object.</span> -00087 <span class="keywordtype">void</span>* Reference(<span class="keyword">const</span> <span class="keywordtype">char</span>* name) <span class="keyword">const</span>; <span class="comment">// will be obsolete</span> -00088 <span class="keywordtype">void</span>* Reference(<span class="keyword">const</span> <a class="code" href="H5Exception_8h.html#a0">H5std_string</a>& name) <span class="keyword">const</span>; <span class="comment">// will be obsolete</span> -00089 -00090 <span class="comment">// Returns this class name</span> -<a name="l00091"></a><a class="code" href="classH5_1_1DataSet.html#a20">00091</a> <span class="keyword">virtual</span> <a class="code" href="H5Exception_8h.html#a0">H5std_string</a> fromClass ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(<span class="stringliteral">"DataSet"</span>); } -00092 -00093 <span class="comment">// Creates a dataset by way of dereference.</span> -00094 DataSet(<a class="code" href="classH5_1_1IdComponent.html">IdComponent</a>& obj, <span class="keywordtype">void</span>* ref); -00095 -00096 <span class="comment">// Default constructor.</span> -00097 DataSet(); -00098 -00099 <span class="comment">// Copy constructor.</span> -00100 DataSet( <span class="keyword">const</span> DataSet& original ); -00101 -00102 <span class="comment">// Creates a copy of an existing DataSet using its id.</span> -00103 DataSet(<span class="keyword">const</span> hid_t existing_id); -00104 -00105 <span class="comment">// Destructor: properly terminates access to this dataset.</span> -00106 <span class="keyword">virtual</span> ~DataSet(); -00107 -00108 <span class="keyword">private</span>: -00109 <span class="comment">// This function contains the common code that is used by</span> -00110 <span class="comment">// getTypeClass and various API functions getXxxType</span> -00111 <span class="comment">// defined in AbstractDs for generic datatype and specific</span> -00112 <span class="comment">// sub-types</span> -00113 <span class="keyword">virtual</span> hid_t p_get_type() <span class="keyword">const</span>; -00114 }; -00115 <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span> -00116 <span class="preprocessor"></span>} -00117 <span class="preprocessor">#endif</span> -00118 <span class="preprocessor"></span><span class="preprocessor">#endif</span> -</pre></div><hr size="1"><address style="align: right;"><small>Generated on Tue Aug 14 13:56:59 2007 by +<!-- Generated by Doxygen 1.4.7 --> +<div class="tabs"> + <ul> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li id="current"><a href="files.html"><span>Files</span></a></li> + <li><a href="examples.html"><span>Examples</span></a></li> + </ul></div> +<div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul></div> +<h1>H5DataSet.h</h1><a href="H5DataSet_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// C++ informative line for the emacs editor: -*- C++ -*-</span> +<a name="l00002"></a>00002 <span class="comment">/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *</span> +<a name="l00003"></a>00003 <span class="comment"> * Copyright by The HDF Group. *</span> +<a name="l00004"></a>00004 <span class="comment"> * Copyright by the Board of Trustees of the University of Illinois. *</span> +<a name="l00005"></a>00005 <span class="comment"> * All rights reserved. *</span> +<a name="l00006"></a>00006 <span class="comment"> * *</span> +<a name="l00007"></a>00007 <span class="comment"> * This file is part of HDF5. The full HDF5 copyright notice, including *</span> +<a name="l00008"></a>00008 <span class="comment"> * terms governing use, modification, and redistribution, is contained in *</span> +<a name="l00009"></a>00009 <span class="comment"> * the files COPYING and Copyright.html. COPYING can be found at the root *</span> +<a name="l00010"></a>00010 <span class="comment"> * of the source code distribution tree; Copyright.html can be found at the *</span> +<a name="l00011"></a>00011 <span class="comment"> * root level of an installed copy of the electronic HDF5 document set and *</span> +<a name="l00012"></a>00012 <span class="comment"> * is linked from the top-level documents page. It can also be found at *</span> +<a name="l00013"></a>00013 <span class="comment"> * http://hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *</span> +<a name="l00014"></a>00014 <span class="comment"> * access to either file, you may request a copy from help@hdfgroup.org. *</span> +<a name="l00015"></a>00015 <span class="comment"> * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */</span> +<a name="l00016"></a>00016 +<a name="l00017"></a>00017 <span class="comment">// Class DataSet inherits from AbstractDs and provides accesses to a dataset.</span> +<a name="l00018"></a>00018 +<a name="l00019"></a>00019 <span class="preprocessor">#ifndef _H5DataSet_H</span> +<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define _H5DataSet_H</span> +<a name="l00021"></a>00021 <span class="preprocessor"></span> +<a name="l00022"></a>00022 <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span> +<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="keyword">namespace </span>H5 { +<a name="l00024"></a>00024 <span class="preprocessor">#endif</span> +<a name="l00025"></a>00025 <span class="preprocessor"></span> +<a name="l00026"></a><a class="code" href="classH5_1_1DataSet.html">00026</a> <span class="keyword">class </span>H5_DLLCPP DataSet : <span class="keyword">public</span> <a class="code" href="classH5_1_1H5Object.html">H5Object</a>, <span class="keyword">public</span> <a class="code" href="classH5_1_1AbstractDs.html">AbstractDs</a> { +<a name="l00027"></a>00027 <span class="keyword">public</span>: +<a name="l00028"></a>00028 <span class="comment">// Close this dataset.</span> +<a name="l00029"></a>00029 <span class="keyword">virtual</span> <span class="keywordtype">void</span> close(); +<a name="l00030"></a>00030 +<a name="l00031"></a>00031 <span class="comment">// Extends the dataset with unlimited dimension.</span> +<a name="l00032"></a>00032 <span class="keywordtype">void</span> extend( <span class="keyword">const</span> hsize_t* size ) <span class="keyword">const</span>; +<a name="l00033"></a>00033 +<a name="l00034"></a>00034 <span class="comment">// Fills a selection in memory with a value</span> +<a name="l00035"></a>00035 <span class="keywordtype">void</span> fillMemBuf(<span class="keyword">const</span> <span class="keywordtype">void</span> *fill, <a class="code" href="classH5_1_1DataType.html">DataType</a>& fill_type, <span class="keywordtype">void</span> *buf, <a class="code" href="classH5_1_1DataType.html">DataType</a>& buf_type, <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space); +<a name="l00036"></a>00036 <span class="comment">// Fills a selection in memory with zero</span> +<a name="l00037"></a>00037 <span class="keywordtype">void</span> fillMemBuf(<span class="keywordtype">void</span> *buf, <a class="code" href="classH5_1_1DataType.html">DataType</a>& buf_type, <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space); +<a name="l00038"></a>00038 +<a name="l00039"></a>00039 <span class="comment">// Gets the creation property list of this dataset.</span> +<a name="l00040"></a>00040 <a class="code" href="classH5_1_1DSetCreatPropList.html">DSetCreatPropList</a> getCreatePlist() <span class="keyword">const</span>; +<a name="l00041"></a>00041 +<a name="l00042"></a>00042 <span class="comment">// Returns the address of this dataset in the file.</span> +<a name="l00043"></a>00043 haddr_t getOffset() <span class="keyword">const</span>; +<a name="l00044"></a>00044 +<a name="l00045"></a>00045 <span class="comment">// Gets the dataspace of this dataset.</span> +<a name="l00046"></a>00046 <span class="keyword">virtual</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a> getSpace() <span class="keyword">const</span>; +<a name="l00047"></a>00047 +<a name="l00048"></a>00048 <span class="comment">// Determines whether space has been allocated for a dataset.</span> +<a name="l00049"></a>00049 <span class="keywordtype">void</span> getSpaceStatus(H5D_space_status_t& status) <span class="keyword">const</span>; +<a name="l00050"></a>00050 +<a name="l00051"></a>00051 <span class="comment">// Returns the amount of storage size required for this dataset.</span> +<a name="l00052"></a>00052 hsize_t getStorageSize() <span class="keyword">const</span>; +<a name="l00053"></a>00053 +<a name="l00054"></a>00054 <span class="comment">// Returns the number of bytes required to store VL data.</span> +<a name="l00055"></a>00055 hsize_t getVlenBufSize( <a class="code" href="classH5_1_1DataType.html">DataType</a>& type, <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space ) <span class="keyword">const</span>; +<a name="l00056"></a>00056 +<a name="l00057"></a>00057 <span class="comment">// Reclaims VL datatype memory buffers.</span> +<a name="l00058"></a>00058 <span class="keyword">static</span> <span class="keywordtype">void</span> vlenReclaim(<span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist, <span class="keywordtype">void</span>* buf ); +<a name="l00059"></a>00059 <span class="keyword">static</span> <span class="keywordtype">void</span> vlenReclaim(<span class="keywordtype">void</span> *buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = <a class="code" href="classH5_1_1DSetMemXferPropList.html#47bb48aeb00da456b7c9f1d86fdc2acf">DSetMemXferPropList::DEFAULT</a>); +<a name="l00060"></a>00060 +<a name="l00061"></a>00061 <span class="comment">// Reads the data of this dataset and stores it in the provided buffer.</span> +<a name="l00062"></a>00062 <span class="comment">// The memory and file dataspaces and the transferring property list</span> +<a name="l00063"></a>00063 <span class="comment">// can be defaults.</span> +<a name="l00064"></a>00064 <span class="keywordtype">void</span> read( <span class="keywordtype">void</span>* buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& mem_type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& mem_space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& file_space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = <a class="code" href="classH5_1_1DSetMemXferPropList.html#47bb48aeb00da456b7c9f1d86fdc2acf">DSetMemXferPropList::DEFAULT</a> ) <span class="keyword">const</span>; +<a name="l00065"></a>00065 <span class="keywordtype">void</span> read( <a class="code" href="H5Exception_8h.html#5c3fdf56d98d169f63f1b114803db592">H5std_string</a>& buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& mem_type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& mem_space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& file_space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = <a class="code" href="classH5_1_1DSetMemXferPropList.html#47bb48aeb00da456b7c9f1d86fdc2acf">DSetMemXferPropList::DEFAULT</a> ) <span class="keyword">const</span>; +<a name="l00066"></a>00066 +<a name="l00067"></a>00067 <span class="comment">// Writes the buffered data to this dataset.</span> +<a name="l00068"></a>00068 <span class="comment">// The memory and file dataspaces and the transferring property list</span> +<a name="l00069"></a>00069 <span class="comment">// can be defaults.</span> +<a name="l00070"></a>00070 <span class="keywordtype">void</span> write( <span class="keyword">const</span> <span class="keywordtype">void</span>* buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& mem_type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& mem_space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& file_space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = <a class="code" href="classH5_1_1DSetMemXferPropList.html#47bb48aeb00da456b7c9f1d86fdc2acf">DSetMemXferPropList::DEFAULT</a> ) <span class="keyword">const</span>; +<a name="l00071"></a>00071 <span class="keywordtype">void</span> write( <span class="keyword">const</span> <a class="code" href="H5Exception_8h.html#5c3fdf56d98d169f63f1b114803db592">H5std_string</a>& buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& mem_type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& mem_space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& file_space = <a class="code" href="classH5_1_1DataSpace.html#f19fb72eae0855e07830c6d9a6f4748d">DataSpace::ALL</a>, <span class="keyword">const</span> <a class="code" href="classH5_1_1DSetMemXferPropList.html">DSetMemXferPropList</a>& xfer_plist = <a class="code" href="classH5_1_1DSetMemXferPropList.html#47bb48aeb00da456b7c9f1d86fdc2acf">DSetMemXferPropList::DEFAULT</a> ) <span class="keyword">const</span>; +<a name="l00072"></a>00072 +<a name="l00073"></a>00073 <span class="comment">// Iterates the selected elements in the specified dataspace - not implemented in C++ style yet</span> +<a name="l00074"></a>00074 <span class="keywordtype">int</span> iterateElems( <span class="keywordtype">void</span>* buf, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataType.html">DataType</a>& type, <span class="keyword">const</span> <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a>& space, H5D_operator_t op, <span class="keywordtype">void</span>* op_data = NULL ); +<a name="l00075"></a>00075 +<a name="l00076"></a>00076 <span class="comment">// Retrieves the type of object that an object reference points to.</span> +<a name="l00077"></a>00077 H5G_obj_t getObjType(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type = H5R_OBJECT) <span class="keyword">const</span>; +<a name="l00078"></a>00078 +<a name="l00079"></a>00079 <span class="comment">// Retrieves a dataspace with the region pointed to selected.</span> +<a name="l00080"></a>00080 <a class="code" href="classH5_1_1DataSpace.html">DataSpace</a> getRegion(<span class="keywordtype">void</span> *ref, H5R_type_t ref_type = H5R_DATASET_REGION) <span class="keyword">const</span>; +<a name="l00081"></a>00081 +<a name="l00082"></a>00082 <span class="comment">// Returns this class name</span> +<a name="l00083"></a><a class="code" href="classH5_1_1DataSet.html#f789313a3635e675f76dccb10b39e141">00083</a> <span class="keyword">virtual</span> <a class="code" href="H5Exception_8h.html#5c3fdf56d98d169f63f1b114803db592">H5std_string</a> fromClass ()<span class="keyword"> const </span>{ <span class="keywordflow">return</span>(<span class="stringliteral">"DataSet"</span>); } +<a name="l00084"></a>00084 +<a name="l00085"></a>00085 <span class="comment">// Creates a dataset by way of dereference.</span> +<a name="l00086"></a>00086 DataSet(<a class="code" href="classH5_1_1H5Object.html">H5Object</a>& obj, <span class="keywordtype">void</span>* ref, H5R_type_t ref_type = H5R_OBJECT); +<a name="l00087"></a>00087 DataSet(<a class="code" href="classH5_1_1H5File.html">H5File</a>& h5file, <span class="keywordtype">void</span>* ref, H5R_type_t ref_type = H5R_OBJECT); +<a name="l00088"></a>00088 DataSet(<a class="code" href="classH5_1_1Attribute.html">Attribute</a>& attr, <span class="keywordtype">void</span>* ref, H5R_type_t ref_type = H5R_OBJECT); +<a name="l00089"></a>00089 +<a name="l00090"></a>00090 <span class="comment">// Default constructor.</span> +<a name="l00091"></a>00091 DataSet(); +<a name="l00092"></a>00092 +<a name="l00093"></a>00093 <span class="comment">// Copy constructor.</span> +<a name="l00094"></a>00094 DataSet( <span class="keyword">const</span> DataSet& original ); +<a name="l00095"></a>00095 +<a name="l00096"></a>00096 <span class="comment">// Creates a copy of an existing DataSet using its id.</span> +<a name="l00097"></a>00097 DataSet(<span class="keyword">const</span> hid_t existing_id); +<a name="l00098"></a>00098 +<a name="l00099"></a>00099 <span class="comment">// Gets the dataset id.</span> +<a name="l00100"></a>00100 <span class="keyword">virtual</span> hid_t getId() <span class="keyword">const</span>; +<a name="l00101"></a>00101 +<a name="l00102"></a>00102 <span class="comment">// Destructor: properly terminates access to this dataset.</span> +<a name="l00103"></a>00103 <span class="keyword">virtual</span> ~DataSet(); +<a name="l00104"></a>00104 +<a name="l00105"></a>00105 <span class="keyword">protected</span>: +<a name="l00106"></a>00106 <span class="comment">// Sets the dataset id.</span> +<a name="l00107"></a>00107 <span class="keyword">virtual</span> <span class="keywordtype">void</span> p_setId(<span class="keyword">const</span> hid_t new_id); +<a name="l00108"></a>00108 +<a name="l00109"></a>00109 <span class="keyword">private</span>: +<a name="l00110"></a>00110 hid_t id; <span class="comment">// HDF5 dataset id</span> +<a name="l00111"></a>00111 +<a name="l00112"></a>00112 <span class="comment">// This function contains the common code that is used by</span> +<a name="l00113"></a>00113 <span class="comment">// getTypeClass and various API functions getXxxType</span> +<a name="l00114"></a>00114 <span class="comment">// defined in AbstractDs for generic datatype and specific</span> +<a name="l00115"></a>00115 <span class="comment">// sub-types</span> +<a name="l00116"></a>00116 <span class="keyword">virtual</span> hid_t p_get_type() <span class="keyword">const</span>; +<a name="l00117"></a>00117 }; +<a name="l00118"></a>00118 <span class="preprocessor">#ifndef H5_NO_NAMESPACE</span> +<a name="l00119"></a>00119 <span class="preprocessor"></span>} +<a name="l00120"></a>00120 <span class="preprocessor">#endif</span> +<a name="l00121"></a>00121 <span class="preprocessor"></span><span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Mon Jun 1 07:53:27 2009 by <a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.3.9.1 </small></address> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address> </body> </html> |