Sophie

Sophie

distrib > Fedora > 13 > i386 > by-pkgid > eebc325dc36bd6e3b09b9b45133e42f8 > files > 3786

HippoDraw-devel-docs-1.21.1-10.fc13.i686.rpm

<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>HippoDraw Class Library</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link rel="shortcut icon" href="hippoApp.ico">
</head><body>
<!-- Generated by Doxygen 1.6.2 -->
<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><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_bd46360b4c6a7cd846adf95fa79d46e4.html">python</a>
  </div>
</div>
<div class="contents">
<h1>export_CircularBuffer.cxx</h1><a href="export__CircularBuffer_8cxx.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00011"></a>00011 <span class="preprocessor">#ifdef _MSC_VER</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span><span class="comment">// nonstandard extension used &#39;extern&#39; before...</span>
<a name="l00013"></a>00013 <span class="preprocessor"># pragma warning(disable:4231)  </span>
<a name="l00014"></a>00014 <span class="preprocessor"></span>
<a name="l00015"></a>00015 <span class="comment">// needs to have dll-interface used by client</span>
<a name="l00016"></a>00016 <span class="preprocessor"># pragma warning(disable:4251)  </span>
<a name="l00017"></a>00017 <span class="preprocessor"></span>
<a name="l00018"></a>00018 <span class="comment">// non dll-interface struct</span>
<a name="l00019"></a>00019 <span class="preprocessor"># pragma warning(disable:4275)  </span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="comment">// &#39;int&#39; : forcing value to bool &#39;true&#39; or &#39;false&#39; (performance warning)</span>
<a name="l00022"></a>00022 <span class="preprocessor"># pragma warning(disable:4800)  </span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="comment">// include first to avoid _POSIX_C_SOURCE warning.</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;boost/python.hpp&gt;</span>
<a name="l00027"></a>00027 
<a name="l00028"></a>00028 <span class="preprocessor">#include &quot;<a class="code" href="CircularBuffer_8h.html" title="CircularBuffer class interface.">datasrcs/CircularBuffer.h</a>&quot;</span>
<a name="l00029"></a>00029 
<a name="l00030"></a>00030 <span class="keyword">using</span> std::vector;
<a name="l00031"></a>00031 <span class="keyword">using namespace </span>boost::python;
<a name="l00032"></a>00032 
<a name="l00033"></a>00033 <span class="keyword">namespace </span>hippodraw {
<a name="l00034"></a>00034 <span class="keyword">namespace </span>Python {
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="keywordtype">void</span>
<a name="l00037"></a>00037 <a class="code" href="namespacehippodraw_1_1Python.html#adebc7c56a5627eb26d0ba509bc9e357e" title="Exports the CircularBuffer class to Python.">export_CircularBuffer</a>()
<a name="l00038"></a>00038 {
<a name="l00039"></a>00039   class_ &lt; CircularBuffer, bases &lt; NTuple &gt; &gt;
<a name="l00040"></a>00040     ( <span class="stringliteral">&quot;CircularBuffer&quot;</span>,
<a name="l00041"></a>00041       <span class="stringliteral">&quot;A circular buffer in a NTuple that adds rows up to a defined number,\n&quot;</span>
<a name="l00042"></a>00042       <span class="stringliteral">&quot;then starts replacing the oldest rows.&quot;</span>,
<a name="l00043"></a>00043       init&lt;&gt; 
<a name="l00044"></a>00044       ( <span class="stringliteral">&quot;CircularBuffer ( None ) -&gt; CircularBuffer\n&quot;</span>
<a name="l00045"></a>00045         <span class="stringliteral">&quot;CircularBuffer ( value ) -&gt; CircularBuffer\n&quot;</span>
<a name="l00046"></a>00046         <span class="stringliteral">&quot;CircularBuffer ( string ) -&gt; CircularBuffer\n&quot;</span>
<a name="l00047"></a>00047         <span class="stringliteral">&quot;CircularBuffer ( sequence ) -&gt; CircularBuffer \n&quot;</span>
<a name="l00048"></a>00048         <span class="stringliteral">&quot;CircularBuffer ( CircularBuffer ) -&gt; CircularBuffer\n&quot;</span>
<a name="l00049"></a>00049         <span class="stringliteral">&quot;\n&quot;</span>
<a name="l00050"></a>00050         <span class="stringliteral">&quot;There are five forms of construction of a CircularBuffer.   The\n&quot;</span>
<a name="l00051"></a>00051         <span class="stringliteral">&quot;first form creates an empty one.   The second from creates an empty\n&quot;</span>
<a name="l00052"></a>00052         <span class="stringliteral">&quot;one with `value&#39; number of columns.   The third from creates an\n&quot;</span>
<a name="l00053"></a>00053         <span class="stringliteral">&quot;empty one the number of columns equal to the size of the sequence.\n&quot;</span>
<a name="l00054"></a>00054         <span class="stringliteral">&quot;The column labels are taken from the sequence.   The final form is\n&quot;</span>
<a name="l00055"></a>00055         <span class="stringliteral">&quot;the copy constructor.&quot;</span> ) )
<a name="l00056"></a>00056 
<a name="l00057"></a>00057     .def ( init &lt; int &gt; () )
<a name="l00058"></a>00058 
<a name="l00059"></a>00059     .def ( init &lt; const std::string &amp; &gt; () )
<a name="l00060"></a>00060 
<a name="l00061"></a>00061     .def ( init &lt; <span class="keyword">const</span> std::vector &lt; std::string  &gt; &amp; &gt; () )
<a name="l00062"></a>00062 
<a name="l00063"></a>00063     .def ( init &lt; const CircularBuffer &amp; &gt; () )
<a name="l00064"></a>00064 
<a name="l00065"></a>00065     .add_property ( <span class="stringliteral">&quot;rows&quot;</span>, &amp;<a class="code" href="classhippodraw_1_1NTuple.html#a2b76a8f13ad489df9fa8cc9452c9012b" title="Returns the number of rows.">CircularBuffer::rows</a> )
<a name="l00066"></a>00066 
<a name="l00067"></a>00067     .add_property ( <span class="stringliteral">&quot;columns&quot;</span>, &amp;<a class="code" href="classhippodraw_1_1DataSource.html#a903d6ffef3ddea0d904a5336e231b643" title="Returns the number of columns or data arrays available from this DataSource.">CircularBuffer::columns</a> )
<a name="l00068"></a>00068 
<a name="l00069"></a>00069     .def ( <span class="stringliteral">&quot;addRow&quot;</span>, &amp;<a class="code" href="classhippodraw_1_1CircularBuffer.html#a9fca4555396ff541ebe4a7120d5ef8a0" title="Adds a row to the buffer.">CircularBuffer::addRow</a>,
<a name="l00070"></a>00070            <span class="stringliteral">&quot;addRow ( sequence ) -&gt; None\n&quot;</span>
<a name="l00071"></a>00071            <span class="stringliteral">&quot;\n&quot;</span>
<a name="l00072"></a>00072            <span class="stringliteral">&quot;Append a row at the end of the table until it is full,\n&quot;</span>
<a name="l00073"></a>00073            <span class="stringliteral">&quot;then replace the oldest row.&quot;</span> )
<a name="l00074"></a>00074 
<a name="l00075"></a>00075     .def ( <span class="stringliteral">&quot;reserve&quot;</span>, &amp;<a class="code" href="classhippodraw_1_1CircularBuffer.html#a595acdd9cae86ec28dd0f894833a8c0d" title="Sets the size, in rows, of the circular buffer.">CircularBuffer::reserve</a>,
<a name="l00076"></a>00076            <span class="stringliteral">&quot;reserve ( value ) -&gt; None\n&quot;</span>
<a name="l00077"></a>00077            <span class="stringliteral">&quot;\n&quot;</span>
<a name="l00078"></a>00078            <span class="stringliteral">&quot;Sets the maximum size of the buffer&quot;</span> )
<a name="l00079"></a>00079 
<a name="l00080"></a>00080      .def ( <span class="stringliteral">&quot;clear&quot;</span>, &amp;<a class="code" href="classhippodraw_1_1CircularBuffer.html#ac8bb3912a3ce86b15842e79d0b421204" title="Clears the contents without changing the capacity.">CircularBuffer::clear</a>,
<a name="l00081"></a>00081             <span class="stringliteral">&quot;clear ( None ) -&gt; None\n&quot;</span>
<a name="l00082"></a>00082             <span class="stringliteral">&quot;\n&quot;</span>
<a name="l00083"></a>00083             <span class="stringliteral">&quot;Clears the contents of the buffer&quot;</span> )
<a name="l00084"></a>00084 
<a name="l00085"></a>00085     ; 
<a name="l00086"></a>00086 }
<a name="l00087"></a>00087 
<a name="l00088"></a>00088 } <span class="comment">// namespace Python</span>
<a name="l00089"></a>00089 } <span class="comment">// namespace hippodraw</span>
</pre></div></div>
<hr size="1"><address style="align: right;"><small>
Generated for HippoDraw Class Library by <a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0>
</a> </small></address>
</body>
</html>