Sophie

Sophie

distrib > Mandriva > 2010.1 > x86_64 > by-pkgid > aaf33964de706a538481c929c1da6a44 > files > 2510

faust-doc-0.9.10-5mdv2010.1.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>FAUST compiler: cableSchema Class 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.6.3 -->
<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 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="classes.html"><span>Class&nbsp;Index</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>cableSchema Class Reference</h1><!-- doxytag: class="cableSchema" --><!-- doxytag: inherits="schema" -->
<p>Simple cables (identity box) in parallel.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="cableSchema_8h_source.html">cableSchema.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="classschema.html">schema</a>.</p>
<div class="dynheader">
Collaboration diagram for cableSchema:</div>
<div class="dynsection">
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classcableSchema-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcableSchema.html#aadcd0c8503c379974bcdc839f51424f9">place</a> (double x, double y, int orientation)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Place the communication points vertically spaced by dWire.  <a href="#aadcd0c8503c379974bcdc839f51424f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcableSchema.html#a46195fb0771902257c7a6c4cbcbc3ac1">draw</a> (<a class="el" href="classdevice.html">device</a> &amp;dev)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Nothing to draw.  <a href="#a46195fb0771902257c7a6c4cbcbc3ac1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structpoint.html">point</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcableSchema.html#af8df67f21052f8f6f527dff881294a15">inputPoint</a> (unsigned int i) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">input and output points are the same as the width is 0  <a href="#af8df67f21052f8f6f527dff881294a15"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="structpoint.html">point</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcableSchema.html#a690f77c690356d109205dd51ea55af0e">outputPoint</a> (unsigned int i) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">input and output points are the same as the width is 0  <a href="#a690f77c690356d109205dd51ea55af0e"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcableSchema.html#ab8260f9dc2abdcd24014d0bf9576e303">cableSchema</a> (unsigned int n)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build n cables in parallel.  <a href="#ab8260f9dc2abdcd24014d0bf9576e303"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="structpoint.html">point</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcableSchema.html#a7a7da86e43db718c9d91eef1efcbce5a">fPoint</a></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classschema.html">schema</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcableSchema.html#aa5b7242ed5c2ea862d01978390a1bdda">makeCableSchema</a> (unsigned int n)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Build n cables in parallel.  <a href="#aa5b7242ed5c2ea862d01978390a1bdda"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Simple cables (identity box) in parallel. </p>
<p>The width of a cable is null. Therefore input and output connection points are the same. The constructor is private to enforce the use of makeCableSchema. </p>

<p>Definition at line <a class="el" href="cableSchema_8h_source.html#l00034">34</a> of file <a class="el" href="cableSchema_8h_source.html">cableSchema.h</a>.</p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab8260f9dc2abdcd24014d0bf9576e303"></a><!-- doxytag: member="cableSchema::cableSchema" ref="ab8260f9dc2abdcd24014d0bf9576e303" args="(unsigned int n)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">cableSchema::cableSchema </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>n</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Build n cables in parallel. </p>

<p>Definition at line <a class="el" href="cableSchema_8cpp_source.html#l00042">42</a> of file <a class="el" href="cableSchema_8cpp_source.html">cableSchema.cpp</a>.</p>

<p>References <a class="el" href="cableSchema_8h_source.html#l00036">fPoint</a>.</p>

<p><div class="fragment"><pre class="fragment"><a name="l00043"></a>00043     :   <a class="code" href="classschema.html#a05b1cb48791b70b1ae5706e9a29020c9">schema</a> (n, n, 0, n*<a class="code" href="schema_8h.html#a30d1c9623bb68689e23907427368ed1f" title="distance between two wires">dWire</a>)
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045     <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;n; i++)    <a class="code" href="classcableSchema.html#a7a7da86e43db718c9d91eef1efcbce5a">fPoint</a>.push_back(<a class="code" href="structpoint.html">point</a>(0));
<a name="l00046"></a>00046 }
</pre></div></p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a46195fb0771902257c7a6c4cbcbc3ac1"></a><!-- doxytag: member="cableSchema::draw" ref="a46195fb0771902257c7a6c4cbcbc3ac1" args="(device &amp;dev)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cableSchema::draw </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classdevice.html">device</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>dev</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Nothing to draw. </p>
<p>Actual drawing will take place when the wires are enlargered </p>

<p>Implements <a class="el" href="classschema.html#a6b8ab062669efb5f96e45d4e40f123b0">schema</a>.</p>

<p>Definition at line <a class="el" href="cableSchema_8cpp_source.html#l00073">73</a> of file <a class="el" href="cableSchema_8cpp_source.html">cableSchema.cpp</a>.</p>

<p><div class="fragment"><pre class="fragment"><a name="l00074"></a>00074 {
<a name="l00075"></a>00075 }
</pre></div></p>

</div>
</div>
<a class="anchor" id="af8df67f21052f8f6f527dff881294a15"></a><!-- doxytag: member="cableSchema::inputPoint" ref="af8df67f21052f8f6f527dff881294a15" args="(unsigned int i) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structpoint.html">point</a> cableSchema::inputPoint </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>input and output points are the same as the width is 0 </p>

<p>Implements <a class="el" href="classschema.html#a6b533651c7b65aeec424762c42777bd8">schema</a>.</p>

<p>Definition at line <a class="el" href="cableSchema_8cpp_source.html#l00080">80</a> of file <a class="el" href="cableSchema_8cpp_source.html">cableSchema.cpp</a>.</p>

<p>References <a class="el" href="cableSchema_8h_source.html#l00036">fPoint</a>, and <a class="el" href="schema_8h_source.html#l00087">schema::inputs()</a>.</p>

<p><div class="fragment"><pre class="fragment"><a name="l00081"></a>00081 {
<a name="l00082"></a>00082     assert(i&lt;<a class="code" href="classschema.html#ac0d35106760b7d113718e9ee9d02e108">inputs</a>());
<a name="l00083"></a>00083     <span class="keywordflow">return</span> <a class="code" href="classcableSchema.html#a7a7da86e43db718c9d91eef1efcbce5a">fPoint</a>[i];
<a name="l00084"></a>00084 }
</pre></div></p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>

</div>
</div>
<a class="anchor" id="a690f77c690356d109205dd51ea55af0e"></a><!-- doxytag: member="cableSchema::outputPoint" ref="a690f77c690356d109205dd51ea55af0e" args="(unsigned int i) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structpoint.html">point</a> cableSchema::outputPoint </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>i</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>input and output points are the same as the width is 0 </p>

<p>Implements <a class="el" href="classschema.html#a9521bca5db264dfdd0f523e1c3c03263">schema</a>.</p>

<p>Definition at line <a class="el" href="cableSchema_8cpp_source.html#l00089">89</a> of file <a class="el" href="cableSchema_8cpp_source.html">cableSchema.cpp</a>.</p>

<p>References <a class="el" href="cableSchema_8h_source.html#l00036">fPoint</a>, and <a class="el" href="schema_8h_source.html#l00088">schema::outputs()</a>.</p>

<p><div class="fragment"><pre class="fragment"><a name="l00090"></a>00090 {
<a name="l00091"></a>00091     assert(i&lt;<a class="code" href="classschema.html#a217dc5df9996203d3ea0521c84c38567">outputs</a>());
<a name="l00092"></a>00092     <span class="keywordflow">return</span> <a class="code" href="classcableSchema.html#a7a7da86e43db718c9d91eef1efcbce5a">fPoint</a>[i];
<a name="l00093"></a>00093 }
</pre></div></p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>

</div>
</div>
<a class="anchor" id="aadcd0c8503c379974bcdc839f51424f9"></a><!-- doxytag: member="cableSchema::place" ref="aadcd0c8503c379974bcdc839f51424f9" args="(double x, double y, int orientation)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cableSchema::place </td>
          <td>(</td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">double&nbsp;</td>
          <td class="paramname"> <em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>orientation</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Place the communication points vertically spaced by dWire. </p>

<p>Implements <a class="el" href="classschema.html#aa3ef082636956bead276445f203259a4">schema</a>.</p>

<p>Definition at line <a class="el" href="cableSchema_8cpp_source.html#l00052">52</a> of file <a class="el" href="cableSchema_8cpp_source.html">cableSchema.cpp</a>.</p>

<p>References <a class="el" href="schema_8h_source.html#l00091">schema::beginPlace()</a>, <a class="el" href="schema_8h_source.html#l00032">dWire</a>, <a class="el" href="schema_8h_source.html#l00093">schema::endPlace()</a>, <a class="el" href="cableSchema_8h_source.html#l00036">fPoint</a>, <a class="el" href="schema_8h_source.html#l00086">schema::height()</a>, <a class="el" href="schema_8h_source.html#l00087">schema::inputs()</a>, and <a class="el" href="schema_8h_source.html#l00050">kLeftRight</a>.</p>

<p><div class="fragment"><pre class="fragment"><a name="l00053"></a>00053 {
<a name="l00054"></a>00054     <a class="code" href="classschema.html#a84e7eb74cb2a656495a93985db7d5c9d">beginPlace</a>(ox, oy, <a class="code" href="classschema.html#a929b2d9ad9fabd5f41623cbfce72c1d3">orientation</a>);
<a name="l00055"></a>00055     <span class="keywordflow">if</span> (<a class="code" href="classschema.html#a929b2d9ad9fabd5f41623cbfce72c1d3">orientation</a> == <a class="code" href="schema_8h.html#adf764cbdea00d65edcd07bb9953ad2b7ad0e4d4a0baf519fc3f4a41e2d30f4e96">kLeftRight</a>) {
<a name="l00056"></a>00056         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;<a class="code" href="classschema.html#ac0d35106760b7d113718e9ee9d02e108">inputs</a>(); i++) {
<a name="l00057"></a>00057             <a class="code" href="classcableSchema.html#a7a7da86e43db718c9d91eef1efcbce5a">fPoint</a>[i] = <a class="code" href="structpoint.html">point</a>(ox, oy + <a class="code" href="schema_8h.html#a30d1c9623bb68689e23907427368ed1f" title="distance between two wires">dWire</a>/2.0 + i*<a class="code" href="schema_8h.html#a30d1c9623bb68689e23907427368ed1f" title="distance between two wires">dWire</a>);
<a name="l00058"></a>00058         }
<a name="l00059"></a>00059     } <span class="keywordflow">else</span> {
<a name="l00060"></a>00060         <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i=0; i&lt;<a class="code" href="classschema.html#ac0d35106760b7d113718e9ee9d02e108">inputs</a>(); i++) {
<a name="l00061"></a>00061             <a class="code" href="classcableSchema.html#a7a7da86e43db718c9d91eef1efcbce5a">fPoint</a>[i] = <a class="code" href="structpoint.html">point</a>(ox, oy + <a class="code" href="classschema.html#acd72d5b630acd4eadf3f856aa6176c99">height</a>() - <a class="code" href="schema_8h.html#a30d1c9623bb68689e23907427368ed1f" title="distance between two wires">dWire</a>/2.0 - i*<a class="code" href="schema_8h.html#a30d1c9623bb68689e23907427368ed1f" title="distance between two wires">dWire</a>);
<a name="l00062"></a>00062         }
<a name="l00063"></a>00063     }
<a name="l00064"></a>00064     <a class="code" href="classschema.html#ad579c7aebc79bfbed5f73b35c399ff83">endPlace</a>();
<a name="l00065"></a>00065 }
</pre></div></p>

<p><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dynsection">
</div>
</p>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="aa5b7242ed5c2ea862d01978390a1bdda"></a><!-- doxytag: member="cableSchema::makeCableSchema" ref="aa5b7242ed5c2ea862d01978390a1bdda" args="(unsigned int n)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classschema.html">schema</a>* makeCableSchema </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>n</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Build n cables in parallel. </p>

<p>Definition at line <a class="el" href="cableSchema_8cpp_source.html#l00032">32</a> of file <a class="el" href="cableSchema_8cpp_source.html">cableSchema.cpp</a>.</p>

<p><div class="fragment"><pre class="fragment"><a name="l00033"></a>00033 {
<a name="l00034"></a>00034     assert(n&gt;0);
<a name="l00035"></a>00035     <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="classcableSchema.html#ab8260f9dc2abdcd24014d0bf9576e303" title="Build n cables in parallel.">cableSchema</a>(n);
<a name="l00036"></a>00036 }
</pre></div></p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a7a7da86e43db718c9d91eef1efcbce5a"></a><!-- doxytag: member="cableSchema::fPoint" ref="a7a7da86e43db718c9d91eef1efcbce5a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vector&lt;<a class="el" href="structpoint.html">point</a>&gt; <a class="el" href="classcableSchema.html#a7a7da86e43db718c9d91eef1efcbce5a">cableSchema::fPoint</a><code> [private]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="cableSchema_8h_source.html#l00036">36</a> of file <a class="el" href="cableSchema_8h_source.html">cableSchema.h</a>.</p>

<p>Referenced by <a class="el" href="cableSchema_8cpp_source.html#l00042">cableSchema()</a>, <a class="el" href="cableSchema_8cpp_source.html#l00080">inputPoint()</a>, <a class="el" href="cableSchema_8cpp_source.html#l00089">outputPoint()</a>, and <a class="el" href="cableSchema_8cpp_source.html#l00052">place()</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="cableSchema_8h_source.html">cableSchema.h</a></li>
<li><a class="el" href="cableSchema_8cpp_source.html">cableSchema.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Apr 29 00:00:17 2010 for FAUST compiler by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>