Mercurial > hg > aimc
view trunk/C++/api/html/classEarComponent.html @ 597:359bcd461dd1
First commit. Refer to the api [1] 'Philosophy of the implementation' for information on the approach used to implement CARFAC in C++.
[1] aimc/C++/api/html/index.html
| author | flatmax |
|---|---|
| date | Sat, 09 Feb 2013 23:53:48 +0000 |
| parents | |
| children | b4323584c9fa |
line wrap: on
line source
<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>CARFAC C++: EarComponent< COEFFTYPE, PARAMTYPE, STATETYPE > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="icon.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CARFAC C++ </div> <div id="projectbrief">C++ implementation of CARFAC</div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.6.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</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> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> initNavTree('classEarComponent.html',''); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-attribs">Protected Attributes</a> </div> <div class="headertitle"> <div class="title">EarComponent< COEFFTYPE, PARAMTYPE, STATETYPE > Class Template Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="EarComponent" --> <p><code>#include <<a class="el" href="EarComponent_8H_source.html">EarComponent.H</a>></code></p> <div class="dynheader"> Collaboration diagram for EarComponent< COEFFTYPE, PARAMTYPE, STATETYPE >:</div> <div class="dyncontent"> <div class="center"><img src="classEarComponent__coll__graph.png" border="0" usemap="#EarComponent_3_01COEFFTYPE_00_01PARAMTYPE_00_01STATETYPE_01_4_coll__map" alt="Collaboration graph"/></div> <map name="EarComponent_3_01COEFFTYPE_00_01PARAMTYPE_00_01STATETYPE_01_4_coll__map" id="EarComponent_3_01COEFFTYPE_00_01PARAMTYPE_00_01STATETYPE_01_4_coll__map"> </map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classEarComponent-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#afde50640ddf67626e8e62926d491269d">EarComponent</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#a0eaf3faf1ec50098fa5b3cdb21ffea6e">~EarComponent</a> ()</td></tr> <tr><td colspan="2"><h2><a name="pro-attribs"></a> Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">COEFFTYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#a43461ed3bac1bd735ea6ddee5dda2594">coeff</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">PARAMTYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#af409ffb12bafa60c09f319fa6edd48b9">param</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">STATETYPE </td><td class="memItemRight" valign="bottom"><a class="el" href="classEarComponent.html#a4ea8ae90cda6efc8b1b79550545a9210">state</a></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><h3>template<class COEFFTYPE, class PARAMTYPE, class STATETYPE><br/> class EarComponent< COEFFTYPE, PARAMTYPE, STATETYPE ></h3> <dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax <flatmax@>} </dd></dl> <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl> <p>This class is inherited by the <a class="el" href="classCAR.html">CAR</a>, <a class="el" href="classAGC.html">AGC</a> and <a class="el" href="classIHC.html">IHC</a> classes. This class groups <a class="el" href="classParameters.html">Parameters</a>, Coefficient and <a class="el" href="classState.html">State</a> classes. </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="afde50640ddf67626e8e62926d491269d"></a><!-- doxytag: member="EarComponent::EarComponent" ref="afde50640ddf67626e8e62926d491269d" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class COEFFTYPE, class PARAMTYPE, class STATETYPE> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classEarComponent.html">EarComponent</a>< COEFFTYPE, PARAMTYPE, STATETYPE >::<a class="el" href="classEarComponent.html">EarComponent</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a0eaf3faf1ec50098fa5b3cdb21ffea6e"></a><!-- doxytag: member="EarComponent::~EarComponent" ref="a0eaf3faf1ec50098fa5b3cdb21ffea6e" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class COEFFTYPE, class PARAMTYPE, class STATETYPE> </div> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classEarComponent.html">EarComponent</a>< COEFFTYPE, PARAMTYPE, STATETYPE >::~<a class="el" href="classEarComponent.html">EarComponent</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a43461ed3bac1bd735ea6ddee5dda2594"></a><!-- doxytag: member="EarComponent::coeff" ref="a43461ed3bac1bd735ea6ddee5dda2594" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class COEFFTYPE, class PARAMTYPE, class STATETYPE> </div> <table class="memname"> <tr> <td class="memname">COEFFTYPE <a class="el" href="classEarComponent.html">EarComponent</a>< COEFFTYPE, PARAMTYPE, STATETYPE >::<a class="el" href="classEarComponent.html#a43461ed3bac1bd735ea6ddee5dda2594">coeff</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="af409ffb12bafa60c09f319fa6edd48b9"></a><!-- doxytag: member="EarComponent::param" ref="af409ffb12bafa60c09f319fa6edd48b9" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class COEFFTYPE, class PARAMTYPE, class STATETYPE> </div> <table class="memname"> <tr> <td class="memname">PARAMTYPE <a class="el" href="classEarComponent.html">EarComponent</a>< COEFFTYPE, PARAMTYPE, STATETYPE >::<a class="el" href="classEarComponent.html#af409ffb12bafa60c09f319fa6edd48b9">param</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a4ea8ae90cda6efc8b1b79550545a9210"></a><!-- doxytag: member="EarComponent::state" ref="a4ea8ae90cda6efc8b1b79550545a9210" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<class COEFFTYPE, class PARAMTYPE, class STATETYPE> </div> <table class="memname"> <tr> <td class="memname">STATETYPE <a class="el" href="classEarComponent.html">EarComponent</a>< COEFFTYPE, PARAMTYPE, STATETYPE >::<a class="el" href="classEarComponent.html#a4ea8ae90cda6efc8b1b79550545a9210">state</a><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="EarComponent_8H_source.html">EarComponent.H</a></li> </ul> </div><!-- contents --> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="classEarComponent.html">EarComponent</a> </li> <li class="footer">Generated on Sun Feb 10 2013 10:47:46 for CARFAC C++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li> </ul> </div> </body> </html>