1877 lines
87 KiB
HTML
1877 lines
87 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>H5Part: H5Part.h File Reference</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.4.4 -->
|
|
<div class="qindex"><a class="qindex" href="index.html">Main Page</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></div>
|
|
<h1>H5Part.h File Reference</h1><code>#include <hdf5.h></code><br>
|
|
|
|
<p>
|
|
<a href="H5Part_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structH5PartFile.html">H5PartFile</a></td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a0">H5PART_READ</a> 0x01</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a1">H5PART_WRITE</a> 0x02</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a2">H5PartOpenFileSerial</a>(x, y) H5PartOpenFile(x,y)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a3">H5PartResetView</a>(f) H5PartSetView(f,-1,-1)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a4">H5PartHasView</a>(f) ((f->viewstart<0||f->viewend<0)?0:1)</td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structH5PartFile.html">H5PartFile</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a5">H5PartFile</a></td></tr>
|
|
|
|
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a6">H5PartOpenFile</a> (const char *filename, unsigned flags)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a7">H5PartFileIsValid</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a8">H5PartCloseFile</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a9">H5PartSetNumParticles</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, long long nparticles)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a10">H5PartWriteDataFloat64</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, double *array)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a11">H5PartWriteDataInt64</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, long long *array)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a12">H5PartSetStep</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, int step)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a13">H5PartGetNumSteps</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a14">H5PartGetNumDatasets</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a15">H5PartGetDatasetName</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, int index, char *name, int maxlen)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">long long </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a16">H5PartGetNumParticles</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a17">H5PartSetView</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, long long start, long long end)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a18">H5PartGetView</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, long long *start, long long *end)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a19">H5PartSetCanonicalView</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a20">H5PartReadDataFloat64</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, double *array)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a21">H5PartReadDataInt64</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, long long *array)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a22">H5PartReadParticleStep</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, int step, double *x, double *y, double *z, double *px, double *py, double *pz, long long *id)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a23">H5PartWriteStepAttrib</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, hid_t type, void *attrib, int nelem)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a24">H5PartWriteFileAttrib</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, hid_t type, void *attrib, int nelem)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a25">H5PartWriteAttrib</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, hid_t type, void *attrib, int nelem)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a26">H5PartWriteFileAttribString</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, char *attrib)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a27">H5PartWriteStepAttribString</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, char *attrib)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a28">H5PartGetNumStepAttribs</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a29">H5PartGetNumFileAttribs</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a30">H5PartGetStepAttribInfo</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, int idx, char *name, size_t maxnamelen, hid_t *type, int *nelem)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a31">H5PartGetFileAttribInfo</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, int idx, char *name, size_t maxnamelen, hid_t *type, int *nelem)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a32">H5PartReadStepAttrib</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, void *data)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a33">H5PartReadAttrib</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, void *data)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a34">H5PartReadFileAttrib</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *name, void *data)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a35">H5PartStashFile</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *filename)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a36">H5PartUnstashFile</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, char *filename, char *outputpath)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a37">H5PartGetNumStashFiles</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f)</td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="H5Part_8h.html#a38">H5PartFileGetStashFileName</a> (<a class="el" href="structH5PartFile.html">H5PartFile</a> *f, int nameindex, char *filename, int maxnamelen)</td></tr>
|
|
|
|
</table>
|
|
<hr><h2>Define Documentation</h2>
|
|
<a class="anchor" name="a0"></a><!-- doxytag: member="H5Part.h::H5PART_READ" ref="a0" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define H5PART_READ 0x01 </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a1"></a><!-- doxytag: member="H5Part.h::H5PART_WRITE" ref="a1" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define H5PART_WRITE 0x02 </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a4"></a><!-- doxytag: member="H5Part.h::H5PartHasView" ref="a4" args="(f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define H5PartHasView </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">f </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> ((f->viewstart<0||f->viewend<0)?0:1)</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a2"></a><!-- doxytag: member="H5Part.h::H5PartOpenFileSerial" ref="a2" args="(x, y)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define H5PartOpenFileSerial </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">x, <tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>y </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> H5PartOpenFile(x,y)</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a3"></a><!-- doxytag: member="H5Part.h::H5PartResetView" ref="a3" args="(f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">#define H5PartResetView </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">f </td>
|
|
<td class="mdname1" valign="top" nowrap> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap> H5PartSetView(f,-1,-1)</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Typedef Documentation</h2>
|
|
<a class="anchor" name="a5"></a><!-- doxytag: member="H5Part.h::H5PartFile" ref="a5" args="" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">typedef struct <a class="el" href="structH5PartFile.html">H5PartFile</a> <a class="el" href="structH5PartFile.html">H5PartFile</a> </td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
/struct <a class="el" href="structH5PartFile.html">H5PartFile</a>: This is an essentially opaque datastructure that acts as the filehandle for all practical purposes. It is created by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile<xx>()</a> and destroyed by <a class="el" href="H5Part_8c.html#a6">H5PartCloseFile()</a>. </td>
|
|
</tr>
|
|
</table>
|
|
<hr><h2>Function Documentation</h2>
|
|
<a class="anchor" name="a8"></a><!-- doxytag: member="H5Part.h::H5PartCloseFile" ref="a8" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void H5PartCloseFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartCloseFile: closes an open file. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>filehandle of the file to close </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a38"></a><!-- doxytag: member="H5Part.h::H5PartFileGetStashFileName" ref="a38" args="(H5PartFile *f, int nameindex, char *filename, int maxnamelen)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartFileGetStashFileName </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>nameindex</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>maxnamelen</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a7"></a><!-- doxytag: member="H5Part.h::H5PartFileIsValid" ref="a7" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartFileIsValid </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartFileIsValid: checks if a file was successfully opened. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>filehandle of the file to check validity </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 if success 0 if failure</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a15"></a><!-- doxytag: member="H5Part.h::H5PartGetDatasetName" ref="a15" args="(H5PartFile *f, int index, char *name, int maxlen)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartGetDatasetName </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>_index</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>maxlen</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetDatasetName: This reads the name of a datasetes specified by it's index. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>_index</em> </td><td>integer specifying the index of the dataset. If the number of datasets is nds, the range of index is 0 to nds-1. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the dataset. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>maxlen</em> </td><td>An integer specifying the maximum length of the name array. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a31"></a><!-- doxytag: member="H5Part.h::H5PartGetFileAttribInfo" ref="a31" args="(H5PartFile *f, int idx, char *name, size_t maxnamelen, hid_t *type, int *nelem)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void H5PartGetFileAttribInfo </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>idx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>size_t </td>
|
|
<td class="mdname" nowrap> <em>maxname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>hid_t * </td>
|
|
<td class="mdname" nowrap> <em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int * </td>
|
|
<td class="mdname" nowrap> <em>nelem</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetFileAttribInfo: gets the name, type and number of elements of a file attribute . <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>idx</em> </td><td>Index of the attribute </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string with the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>maxname</em> </td><td>The length of the attribute name. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>One of the following ones: H5T_NATIVE_DOUBLE H5T_NATIVE_INT64 H5T_NATIVE_CHAR. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nelem</em> </td><td>Number of elements of type "type". </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>void.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a14"></a><!-- doxytag: member="H5Part.h::H5PartGetNumDatasets" ref="a14" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartGetNumDatasets </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetNumDatasets: This reads the number of datasetes that are stored at a particular time step. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>number of datasets.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a29"></a><!-- doxytag: member="H5Part.h::H5PartGetNumFileAttribs" ref="a29" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartGetNumFileAttribs </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetNumFileAttribs: gets the number of attributes bound to the file. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>number of attributes of the File.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a16"></a><!-- doxytag: member="H5Part.h::H5PartGetNumParticles" ref="a16" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">long long H5PartGetNumParticles </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetNumParticles: This gets the number of particles that are stored in the current timestep. It will arbitrarily select a timestep if you haven't already set the timestep with <a class="el" href="H5Part_8c.html#a24">H5PartSetStep()</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>number of particles in current timestep.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a37"></a><!-- doxytag: member="H5Part.h::H5PartGetNumStashFiles" ref="a37" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartGetNumStashFiles </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetNumStashFiles: returns the number of stashed files. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>Number of stashed files.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a28"></a><!-- doxytag: member="H5Part.h::H5PartGetNumStepAttribs" ref="a28" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartGetNumStepAttribs </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetNumStepAttribs: gets the number of attributes bound to the current step. The step has to be set with <a class="el" href="H5Part_8c.html#a24">H5PartSetStep()</a>. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>number of attributes of the current step.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a13"></a><!-- doxytag: member="H5Part.h::H5PartGetNumSteps" ref="a13" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartGetNumSteps </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetNumSteps: This reads the number of datasteps that are currently stored in the datafile. (simple return of an int). It works for both reading and writing of files, but is probably only typically used when you are reading. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>number of timesteps currently stored in the file.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a30"></a><!-- doxytag: member="H5Part.h::H5PartGetStepAttribInfo" ref="a30" args="(H5PartFile *f, int idx, char *name, size_t maxnamelen, hid_t *type, int *nelem)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void H5PartGetStepAttribInfo </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>idx</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>size_t </td>
|
|
<td class="mdname" nowrap> <em>maxname</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>hid_t * </td>
|
|
<td class="mdname" nowrap> <em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int * </td>
|
|
<td class="mdname" nowrap> <em>nelem</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetStepAttribInfo: gets the name, type and number of elements of a step attribute . <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>idx</em> </td><td>Index of the attribute </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string with the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>maxname</em> </td><td>the length of the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>One of the following ones: H5T_NATIVE_DOUBLE H5T_NATIVE_INT64 H5T_NATIVE_CHAR. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nelem</em> </td><td>Number of elements of type "type". </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>void.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a18"></a><!-- doxytag: member="H5Part.h::H5PartGetView" ref="a18" args="(H5PartFile *f, long long *start, long long *end)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartGetView </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>long long * </td>
|
|
<td class="mdname" nowrap> <em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>long long * </td>
|
|
<td class="mdname" nowrap> <em>end</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartGetView: Allows you to query the current view. Start and End will be -1 if there is no current view established. Use H5PartHasView to see if the view is smaller than the total dataset. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>start particle </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>end particle </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>the number of elements in the view</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a6"></a><!-- doxytag: member="H5Part.h::H5PartOpenFile" ref="a6" args="(const char *filename, unsigned flags)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a>* H5PartOpenFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top">const char * </td>
|
|
<td class="mdname" nowrap> <em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>unsigned </td>
|
|
<td class="mdname" nowrap> <em>flags</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartOpenFile: Opens file with specified filename. If you open with flag H5PART_WRITE, it will truncate any file with the specified filename and start writing to it. If you open with H5PART_READ, then it will open the file readonly.<p>
|
|
<a class="el" href="structH5PartFile.html">H5PartFile</a> should be treated as an essentially opaque datastructure. It acts as the file handle, but internally it maintains several key state variables associated with the file.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The name of the IEEEIO data file to open. The typical extension for these files is .h5 </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>flags</em> </td><td>The accessmode for the file. This is one of 2 different access modes: H5PART_READ, H5PART_WRITE. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>A new filehandle with an open file or NULL if error.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a33"></a><!-- doxytag: member="H5Part.h::H5PartReadAttrib" ref="a33" args="(H5PartFile *f, char *name, void *data)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void H5PartReadAttrib </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>void * </td>
|
|
<td class="mdname" nowrap> <em>data</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartReadAttrib: reads a step attribute NOTE: it has been superseeded by H5PartReadStepAttrib. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string with the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>of the attribute. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, -1 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a20"></a><!-- doxytag: member="H5Part.h::H5PartReadDataFloat64" ref="a20" args="(H5PartFile *f, char *name, double *array)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartReadDataFloat64 </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>double * </td>
|
|
<td class="mdname" nowrap> <em>array</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartReadDataFloat64: This reads in an individual array from a particlar timestep. If you haven't selected a particular timestep, it will pick the current one. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the array. When retrieving datasets from disk, you ask for them by name. There are no restrictions on naming of arrays, but it is useful to arrive at some common naming convention when sharing data with other groups. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>A buffer to read array of particle data. The datatype for elements in the buffer is implicit in the name of the subroutine call. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a21"></a><!-- doxytag: member="H5Part.h::H5PartReadDataInt64" ref="a21" args="(H5PartFile *f, char *name, long long *array)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartReadDataInt64 </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>long long * </td>
|
|
<td class="mdname" nowrap> <em>array</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartReadDataInt64: This reads in an individual array from a particlar timestep. If you haven't selected a particular timestep, it will pick the current one. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the array. When retrieving datasets from disk, you ask for them by name. There are no restrictions on naming of arrays, but it is useful to arrive at some common naming convention when sharing data with other groups. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>A buffer to read array of particle data. The datatype for elements in the buffer is implicit in the name of the subroutine call. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a34"></a><!-- doxytag: member="H5Part.h::H5PartReadFileAttrib" ref="a34" args="(H5PartFile *f, char *name, void *data)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartReadFileAttrib </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>void * </td>
|
|
<td class="mdname" nowrap> <em>data</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartReadFileAttrib: reads a file attribute <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string with the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>Value of the attribute. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, -1 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a22"></a><!-- doxytag: member="H5Part.h::H5PartReadParticleStep" ref="a22" args="(H5PartFile *f, int step, double *x, double *y, double *z, double *px, double *py, double *pz, long long *id)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartReadParticleStep </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>step</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>double * </td>
|
|
<td class="mdname" nowrap> <em>x</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>double * </td>
|
|
<td class="mdname" nowrap> <em>y</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>double * </td>
|
|
<td class="mdname" nowrap> <em>z</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>double * </td>
|
|
<td class="mdname" nowrap> <em>px</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>double * </td>
|
|
<td class="mdname" nowrap> <em>py</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>double * </td>
|
|
<td class="mdname" nowrap> <em>pz</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>long long * </td>
|
|
<td class="mdname" nowrap> <em>id</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartReadParticleStep: This is the mongo read function that pulls in all of the data for a given timestep in one shot. It also takes the timestep as an argument and will call <a class="el" href="H5Part_8c.html#a24">H5PartSetStep()</a> internally so that you don't have to make that call separately. See also: H5PartReadArray() if you want to just read in one of the many arrays. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a32"></a><!-- doxytag: member="H5Part.h::H5PartReadStepAttrib" ref="a32" args="(H5PartFile *f, char *name, void *data)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartReadStepAttrib </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>void * </td>
|
|
<td class="mdname" nowrap> <em>data</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartReadStepAttrib: reads a step attribute <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string with the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>of the attribute. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, -1 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a19"></a><!-- doxytag: member="H5Part.h::H5PartSetCanonicalView" ref="a19" args="(H5PartFile *f)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void H5PartSetCanonicalView </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname1" valign="top" nowrap> <em>f</em> </td>
|
|
<td class="md" valign="top"> ) </td>
|
|
<td class="md" nowrap></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5SetCanonicalView: If it is too tedious to manually set the start and end coordinates for a view, the H5SetCanonicalView() will automatically select an appropriate domain decomposition of the data arrays for the degree of parallelism and set the "view" accordingly. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a9"></a><!-- doxytag: member="H5Part.h::H5PartSetNumParticles" ref="a9" args="(H5PartFile *f, long long nparticles)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void H5PartSetNumParticles </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>long long </td>
|
|
<td class="mdname" nowrap> <em>nparticles</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartSetNumParticles: This function's sole purpose is to prevent needless creation of new HDF5 DataSpace handles if the number of particles is invariant throughout the sim. That's its only reason for existence. After you call this subroutine, all subsequent operations will assume this number of particles will be written. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nparticles</em> </td><td>A long long integer specifying the number of particles </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a12"></a><!-- doxytag: member="H5Part.h::H5PartSetStep" ref="a12" args="(H5PartFile *f, int step)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void H5PartSetStep </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>step</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartSetStep: When writing data to a file the current time step must be set (even if there is only one). In a file with N time steps, the steps are numbered from 0 to N-1. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>step</em> </td><td>the time step to set. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a17"></a><!-- doxytag: member="H5Part.h::H5PartSetView" ref="a17" args="(H5PartFile *f, long long start, long long end)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">void H5PartSetView </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>long long </td>
|
|
<td class="mdname" nowrap> <em>start</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>long long </td>
|
|
<td class="mdname" nowrap> <em>end</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5SetView: For parallel I/O or for subsetting operations on the datafile, the H5SetView subroutine allows you to define a subset of the total particle dataset to read. The concept of "view" works for both serial and for parallel I/O. The "view" will remain in effect until a new view is set, or the number of particles in a dataset changes, or the view is "unset" by calling H5SetView(file,-1,-1);<p>
|
|
Before you set a view, the H5PartGetNumParticles will return the total number of particles in a file (even for the parallel reads). However, after you set a view, it will return the number of particles contained in the view.<p>
|
|
The range is inclusive (the start and the end index).<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>start</em> </td><td>start particle </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>end</em> </td><td>end particle </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>void</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a35"></a><!-- doxytag: member="H5Part.h::H5PartStashFile" ref="a35" args="(H5PartFile *f, char *filename)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartStashFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>filename</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
NOTE: it's missing the read! H5PartStashFile: stash a file in the hdf5 file. If it does not exists a UserData and a Files group will be created. /param f A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. /param filename A null-terminated string for the name of the filename. /return 1 on succes, 0 on failure. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a36"></a><!-- doxytag: member="H5Part.h::H5PartUnstashFile" ref="a36" args="(H5PartFile *f, char *filename, char *outputpath)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartUnstashFile </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>filename</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>outputpath</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartUnstashFile: unstash a file in the hdf5 file. /param f A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. /param filename A null-terminated string for the name of the filename. /param The path to the directory to create the file. /return 1 on succes, 0 on failure. </td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a25"></a><!-- doxytag: member="H5Part.h::H5PartWriteAttrib" ref="a25" args="(H5PartFile *f, char *name, hid_t type, void *attrib, int nelem)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartWriteAttrib </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>hid_t </td>
|
|
<td class="mdname" nowrap> <em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>void * </td>
|
|
<td class="mdname" nowrap> <em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>nelem</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartWriteAttr: writes a step attribute. Note: this call has been superseeded by H5PartWriteStepAttr.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>One of H5T_NATIVE_DOUBLE, H5T_NATIVE_INT64, H5T_NATIVE_CHAR. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nelem</em> </td><td>Number of elements of type "type". </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a10"></a><!-- doxytag: member="H5Part.h::H5PartWriteDataFloat64" ref="a10" args="(H5PartFile *f, char *name, double *array)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartWriteDataFloat64 </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>double * </td>
|
|
<td class="mdname" nowrap> <em>array</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartWriteDataFloat64: After setting the number of particles with <a class="el" href="H5Part_8c.html#a7">H5PartSetNumParticles()</a> and the current timestep using <a class="el" href="H5Part_8c.html#a24">H5PartSetStep()</a>, you can start writing datasets into the file. Each dataset has a name associated with it (chosen by the user) in order to facilitate later retrieval. The writing routines also implicitly store the datatype of the array so that the array can be reconstructed properly on other systems with incompatible type representations. The data is committed to disk before the routine returns. All data that is written after setting the timestep is associated with that timestep. While the number of particles can change for each timestep, you cannot change the number of particles in the middle of a given timestep.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the array. When retrieving datasets from disk, you ask for them by name. There are no restrictions on naming of arrays, but it is useful to arrive at some common naming convention when sharing data with other groups. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>A buffer containing an array of particle data to commit to disk. The datatype for elements in the buffer is implicit in the name of the subroutine call. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a11"></a><!-- doxytag: member="H5Part.h::H5PartWriteDataInt64" ref="a11" args="(H5PartFile *f, char *name, long long *array)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartWriteDataInt64 </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>long long * </td>
|
|
<td class="mdname" nowrap> <em>array</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartWriteDataInt64: After setting the number of particles with <a class="el" href="H5Part_8c.html#a7">H5PartSetNumParticles()</a> and the current timestep using <a class="el" href="H5Part_8c.html#a24">H5PartSetStep()</a>, you can start writing datasets into the file. Each dataset has a name associated with it (chosen by the user) in order to facilitate later retrieval. The writing routines also implicitly store the datatype of the array so that the array can be reconstructed properly on other systems with incompatible type representations. The data is committed to disk before the routine returns. All data that is written after setting the timestep is associated with that timestep. While the number of particles can change for each timestep, you cannot change the number of particles in the middle of a given timestep.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the array. When retrieving datasets from disk, you ask for them by name. There are no restrictions on naming of arrays, but it is useful to arrive at some common naming convention when sharing data with other groups. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>array</em> </td><td>A buffer containing an array of particle data to commit to disk. The datatype for elements in the buffer is implicit in the name of the subroutine call. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a24"></a><!-- doxytag: member="H5Part.h::H5PartWriteFileAttrib" ref="a24" args="(H5PartFile *f, char *name, hid_t type, void *attrib, int nelem)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartWriteFileAttrib </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>hid_t </td>
|
|
<td class="mdname" nowrap> <em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>void * </td>
|
|
<td class="mdname" nowrap> <em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>nelem</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartWriteStepAttr: writes a string attribute bound to a step.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>One of H5T_NATIVE_DOUBLE, H5T_NATIVE_INT64, H5T_NATIVE_CHAR. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nelem</em> </td><td>Number of elements of type "type". </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a26"></a><!-- doxytag: member="H5Part.h::H5PartWriteFileAttribString" ref="a26" args="(H5PartFile *f, char *name, char *attrib)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartWriteFileAttribString </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>attrib</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartWriteFileAttribString: writes a string attribute bound to a file.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>attrib</em> </td><td>A null-terminated string for the attribute. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a23"></a><!-- doxytag: member="H5Part.h::H5PartWriteStepAttrib" ref="a23" args="(H5PartFile *f, char *name, hid_t type, void *attrib, int nelem)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartWriteStepAttrib </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>hid_t </td>
|
|
<td class="mdname" nowrap> <em>type</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>void * </td>
|
|
<td class="mdname" nowrap> <em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>int </td>
|
|
<td class="mdname" nowrap> <em>nelem</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartWriteStepAttrib: writes a step attribute. <dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>One of H5T_NATIVE_DOUBLE, H5T_NATIVE_INT64, H5T_NATIVE_CHAR. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>Value of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nelem</em> </td><td>Number of elements of type "type". </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<a class="anchor" name="a27"></a><!-- doxytag: member="H5Part.h::H5PartWriteStepAttribString" ref="a27" args="(H5PartFile *f, char *name, char *attrib)" --><p>
|
|
<table class="mdTable" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td class="mdRow">
|
|
<table cellpadding="0" cellspacing="0" border="0">
|
|
<tr>
|
|
<td class="md" nowrap valign="top">int H5PartWriteStepAttribString </td>
|
|
<td class="md" valign="top">( </td>
|
|
<td class="md" nowrap valign="top"><a class="el" href="structH5PartFile.html">H5PartFile</a> * </td>
|
|
<td class="mdname" nowrap> <em>f</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md" nowrap align="right"></td>
|
|
<td class="md"></td>
|
|
<td class="md" nowrap>char * </td>
|
|
<td class="mdname" nowrap> <em>attrib</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="md"></td>
|
|
<td class="md">) </td>
|
|
<td class="md" colspan="2"></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table cellspacing="5" cellpadding="0" border="0">
|
|
<tr>
|
|
<td>
|
|
|
|
</td>
|
|
<td>
|
|
|
|
<p>
|
|
H5PartWriteStepAttrString: writes a string attribute bound to the current step.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>f</em> </td><td>A FileHandle opened by <a class="el" href="H5Part_8c.html#a4">H5PartOpenFile()</a> or <a class="el" href="H5Part_8c.html#a3">H5PartOpenFileParallel()</a>. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>A null-terminated string for the name of the attribute. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>attrib</em> </td><td>A null-terminated string for the attribute. </td></tr>
|
|
</table>
|
|
</dl>
|
|
<dl compact><dt><b>Returns:</b></dt><dd>1 on success, 0 on failure.</dd></dl>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<hr size="1"><address style="align: right;"><small>Generated on Tue Jan 31 11:52:45 2006 for H5Part by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
|
|
</body>
|
|
</html>
|