Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > a24e1a39141f9b4ca49bd1e2e23a54ba > files > 306

polybori-doc-0.5rc.p9-6mdv2010.0.i586.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>PolyBoRi: polybori::CIdxVariable&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<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="annotated.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="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 class="navpath"><a class="el" href="namespacepolybori.html">polybori</a>::<a class="el" href="classpolybori_1_1CIdxVariable.html">CIdxVariable</a>
  </div>
</div>
<div class="contents">
<h1>polybori::CIdxVariable&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt; Class Template Reference</h1><!-- doxytag: class="polybori::CIdxVariable" --><code>#include &lt;<a class="el" href="CIdxVariable_8h_source.html">CIdxVariable.h</a>&gt;</code>
<p>

<p>
<a href="classpolybori_1_1CIdxVariable-members.html">List of all members.</a><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="classpolybori_1_1CIdxVariable.html">CIdxVariable</a>&lt; <a class="el" href="classpolybori_1_1CIdxVariable.html#36617c787504d4f8b9c2e9a910a8054e">idx_type</a>, <br class="typebreak">
VarNameLit, VarHeadLit, <br class="typebreak">
VarTailLit &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CIdxVariable.html#a4fdef9db8b9b8ca36fe6ae7f10d2cdd">self</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Type of *this.  <a href="#a4fdef9db8b9b8ca36fe6ae7f10d2cdd"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Adopt global type definitions</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef IdxType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CIdxVariable.html#36617c787504d4f8b9c2e9a910a8054e">idx_type</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#e146a837e32358883da648ea0f83004d">CTypes::ostream_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CIdxVariable.html#8218963bdd56ecf96d9112f1575c46fc">ostream_type</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="classpolybori_1_1CIdxVariable.html#0240c0c7afa0150893fbb7d896491674">CIdxVariable</a> (<a class="el" href="classpolybori_1_1CIdxVariable.html#36617c787504d4f8b9c2e9a910a8054e">idx_type</a> idx_=0)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Construct storage for nlen indices.  <a href="#0240c0c7afa0150893fbb7d896491674"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CIdxVariable.html#7af86bd305355b16fa41bd5765039603">CIdxVariable</a> (const <a class="el" href="classpolybori_1_1CIdxVariable.html">self</a> &amp;rhs)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Copy constructor.  <a href="#7af86bd305355b16fa41bd5765039603"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CIdxVariable.html#3dd0a68f17e5b20001887ffdc00281ac">~CIdxVariable</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor.  <a href="#3dd0a68f17e5b20001887ffdc00281ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classpolybori_1_1CIdxVariable.html#8218963bdd56ecf96d9112f1575c46fc">ostream_type</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CIdxVariable.html#1589668018f9560ae205ae01a6c935d3">print</a> (<a class="el" href="classpolybori_1_1CIdxVariable.html#8218963bdd56ecf96d9112f1575c46fc">ostream_type</a> &amp;os) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print to out-stream.  <a href="#1589668018f9560ae205ae01a6c935d3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classpolybori_1_1CIdxVariable.html#36617c787504d4f8b9c2e9a910a8054e">idx_type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CIdxVariable.html#793c5d32ffad3d2faa9d7aa981895227">idx</a></td></tr>

</table>
<h3>template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt;<br>
 class polybori::CIdxVariable&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;</h3>

<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="36617c787504d4f8b9c2e9a910a8054e"></a><!-- doxytag: member="polybori::CIdxVariable::idx_type" ref="36617c787504d4f8b9c2e9a910a8054e" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef IdxType <a class="el" href="classpolybori_1_1CIdxVariable.html">polybori::CIdxVariable</a>&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;::<a class="el" href="classpolybori_1_1CIdxVariable.html#36617c787504d4f8b9c2e9a910a8054e">idx_type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="8218963bdd56ecf96d9112f1575c46fc"></a><!-- doxytag: member="polybori::CIdxVariable::ostream_type" ref="8218963bdd56ecf96d9112f1575c46fc" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#e146a837e32358883da648ea0f83004d">CTypes::ostream_type</a> <a class="el" href="classpolybori_1_1CIdxVariable.html">polybori::CIdxVariable</a>&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;::<a class="el" href="classpolybori_1_1CIdxVariable.html#8218963bdd56ecf96d9112f1575c46fc">ostream_type</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="a4fdef9db8b9b8ca36fe6ae7f10d2cdd"></a><!-- doxytag: member="polybori::CIdxVariable::self" ref="a4fdef9db8b9b8ca36fe6ae7f10d2cdd" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classpolybori_1_1CIdxVariable.html">CIdxVariable</a>&lt;<a class="el" href="classpolybori_1_1CIdxVariable.html#36617c787504d4f8b9c2e9a910a8054e">idx_type</a>, VarNameLit, VarHeadLit, VarTailLit&gt; <a class="el" href="classpolybori_1_1CIdxVariable.html">polybori::CIdxVariable</a>&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;::<a class="el" href="classpolybori_1_1CIdxVariable.html">self</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Type of *this. 
<p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="0240c0c7afa0150893fbb7d896491674"></a><!-- doxytag: member="polybori::CIdxVariable::CIdxVariable" ref="0240c0c7afa0150893fbb7d896491674" args="(idx_type idx_=0)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classpolybori_1_1CIdxVariable.html">polybori::CIdxVariable</a>&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;::<a class="el" href="classpolybori_1_1CIdxVariable.html">CIdxVariable</a>           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classpolybori_1_1CIdxVariable.html#36617c787504d4f8b9c2e9a910a8054e">idx_type</a>&nbsp;</td>
          <td class="paramname"> <em>idx_</em> = <code>0</code>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Construct storage for nlen indices. 
<p>

</div>
</div><p>
<a class="anchor" name="7af86bd305355b16fa41bd5765039603"></a><!-- doxytag: member="polybori::CIdxVariable::CIdxVariable" ref="7af86bd305355b16fa41bd5765039603" args="(const self &amp;rhs)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classpolybori_1_1CIdxVariable.html">polybori::CIdxVariable</a>&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;::<a class="el" href="classpolybori_1_1CIdxVariable.html">CIdxVariable</a>           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classpolybori_1_1CIdxVariable.html">self</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>rhs</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Copy constructor. 
<p>

</div>
</div><p>
<a class="anchor" name="3dd0a68f17e5b20001887ffdc00281ac"></a><!-- doxytag: member="polybori::CIdxVariable::~CIdxVariable" ref="3dd0a68f17e5b20001887ffdc00281ac" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classpolybori_1_1CIdxVariable.html">polybori::CIdxVariable</a>&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;::~<a class="el" href="classpolybori_1_1CIdxVariable.html">CIdxVariable</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Destructor. 
<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1589668018f9560ae205ae01a6c935d3"></a><!-- doxytag: member="polybori::CIdxVariable::print" ref="1589668018f9560ae205ae01a6c935d3" args="(ostream_type &amp;os) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classpolybori_1_1CIdxVariable.html#8218963bdd56ecf96d9112f1575c46fc">ostream_type</a>&amp; <a class="el" href="classpolybori_1_1CIdxVariable.html">polybori::CIdxVariable</a>&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;::print           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classpolybori_1_1CIdxVariable.html#8218963bdd56ecf96d9112f1575c46fc">ostream_type</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>os</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Print to out-stream. 
<p>

</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="793c5d32ffad3d2faa9d7aa981895227"></a><!-- doxytag: member="polybori::CIdxVariable::idx" ref="793c5d32ffad3d2faa9d7aa981895227" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class IdxType = CTypes::idx_type, class VarNameLit = CStringLiteral&lt;CLiteralCodes::default_variable_name&gt;, class VarHeadLit = CStringLiteral&lt;CLiteralCodes::variable_head&gt;, class VarTailLit = CStringLiteral&lt;CLiteralCodes::variable_tail&gt;&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classpolybori_1_1CIdxVariable.html#36617c787504d4f8b9c2e9a910a8054e">idx_type</a> <a class="el" href="classpolybori_1_1CIdxVariable.html">polybori::CIdxVariable</a>&lt; IdxType, VarNameLit, VarHeadLit, VarTailLit &gt;::<a class="el" href="classpolybori_1_1CIdxVariable.html#793c5d32ffad3d2faa9d7aa981895227">idx</a><code> [protected]</code>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="CIdxVariable_8h_source.html">CIdxVariable.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 9 14:31:02 2009 for PolyBoRi by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>