Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 35

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: OffsetsManager Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="classes.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>OffsetsManager Class Reference</h1><!-- doxytag: class="OffsetsManager" --><code>#include &lt;<a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>&gt;</code>
<p>

<p>
<a href="a07730.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Helper class due to PIMPL excess. 
<p>
This class is deisgned to work within <a class="el" href="a01957.html" title="Superclass for VTK&#39;s XML file writers.">vtkXMLWriter</a>. It store a position in a file (unsigned long) and associate a offset in the file. This is usefull when writing TimeStep XML file when you want to forward the same offset from the AppendData section on every entry in let say &lt;Points&gt; definition Example: <div class="fragment"><pre class="fragment">
 &lt;Points&gt;
   &lt;DataArray type="Float32" TimeStep="0" format="appended" offset="268" /&gt;
   &lt;DataArray type="Float32" TimeStep="1" format="appended" offset="268" /&gt;
   ...
 &lt;/Points&gt;
 </pre></div> Therefore data is only stored once in the XML file. At read time the offset value is stored to determine whenever we need to read data (ie when offset different from previously stored offset)<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a01957.html" title="Superclass for VTK&#39;s XML file writers.">vtkXMLWriter</a> </dd></dl>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>Do not include this file in a header file, it will break PIMPL convention </dd></dl>

<p>Definition at line <a class="el" href="a04956.html#l00053">53</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#1952649e3ad984c8f9f40365996cdf3b">OffsetsManager</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#56380fafcac86c8f0eef9b72589d62b9">~OffsetsManager</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#0e2060daccbc46258abf3106d52535c7">Allocate</a> (int numTimeStep)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#0e8af2d735f668e6126231144ed6c110">GetPosition</a> (unsigned int t)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#fb39da7c7936239db8c5899006f25d2e">GetRangeMinPosition</a> (unsigned int t)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#2e37f80bd3d796b4cd9b4974da3b8152">GetRangeMaxPosition</a> (unsigned int t)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#0575f7ec63c3c469d4f190d80e757633">GetOffsetValue</a> (unsigned int t)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned long &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html#24486302fd3e1f90bf0ea48f6e4206ff">GetLastMTime</a> ()</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="f845390869e2b682beab0871577e7710"></a><!-- doxytag: member="OffsetsManager::OffsetType" ref="f845390869e2b682beab0871577e7710" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> <a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetsManager::OffsetType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00060">60</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="1952649e3ad984c8f9f40365996cdf3b"></a><!-- doxytag: member="OffsetsManager::OffsetsManager" ref="1952649e3ad984c8f9f40365996cdf3b" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OffsetsManager::OffsetsManager           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00063">63</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="56380fafcac86c8f0eef9b72589d62b9"></a><!-- doxytag: member="OffsetsManager::~OffsetsManager" ref="56380fafcac86c8f0eef9b72589d62b9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">OffsetsManager::~OffsetsManager           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00067">67</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0e2060daccbc46258abf3106d52535c7"></a><!-- doxytag: member="OffsetsManager::Allocate" ref="0e2060daccbc46258abf3106d52535c7" args="(int numTimeStep)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void OffsetsManager::Allocate           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>numTimeStep</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00070">70</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0e8af2d735f668e6126231144ed6c110"></a><!-- doxytag: member="OffsetsManager::GetPosition" ref="0e8af2d735f668e6126231144ed6c110" args="(unsigned int t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a>&amp; OffsetsManager::GetPosition           </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>t</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00078">78</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="fb39da7c7936239db8c5899006f25d2e"></a><!-- doxytag: member="OffsetsManager::GetRangeMinPosition" ref="fb39da7c7936239db8c5899006f25d2e" args="(unsigned int t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a>&amp; OffsetsManager::GetRangeMinPosition           </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>t</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00083">83</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2e37f80bd3d796b4cd9b4974da3b8152"></a><!-- doxytag: member="OffsetsManager::GetRangeMaxPosition" ref="2e37f80bd3d796b4cd9b4974da3b8152" args="(unsigned int t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a>&amp; OffsetsManager::GetRangeMaxPosition           </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>t</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00088">88</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="0575f7ec63c3c469d4f190d80e757633"></a><!-- doxytag: member="OffsetsManager::GetOffsetValue" ref="0575f7ec63c3c469d4f190d80e757633" args="(unsigned int t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="a00032.html#f845390869e2b682beab0871577e7710">OffsetType</a>&amp; OffsetsManager::GetOffsetValue           </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>t</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00093">93</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="24486302fd3e1f90bf0ea48f6e4206ff"></a><!-- doxytag: member="OffsetsManager::GetLastMTime" ref="24486302fd3e1f90bf0ea48f6e4206ff" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned long&amp; OffsetsManager::GetLastMTime           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="a04956.html#l00098">98</a> of file <a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/IO/<a class="el" href="a04956.html">vtkOffsetsManagerArray.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:52:09 2009 for VTK by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>