Mercurial > hg > aimc

annotate C++/api/html/classState.html @ 610:01986636257a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Second check-in of Alex Brandmeyer's C++ implementation of CARFAC. Addressed style issues and completed implementation of remaining functions. Still needs proper testing of the output stages against the MATLAB version, and runtime functions need improvements in efficiency.
author alexbrandmeyer
date Thu, 16 May 2013 17:33:23 +0000
parents 97976133eb4d
children
rev   line source
flatmax@592 1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
flatmax@592 2 <html xmlns="http://www.w3.org/1999/xhtml">
flatmax@592 3 <head>
flatmax@592 4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
flatmax@592 5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
flatmax@592 6 <title>CARFAC C++: State Class Reference</title>
flatmax@592 7
flatmax@592 8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
flatmax@592 9 <link href="doxygen.css" rel="stylesheet" type="text/css" />
flatmax@592 10 <link href="navtree.css" rel="stylesheet" type="text/css"/>
flatmax@592 11 <script type="text/javascript" src="jquery.js"></script>
flatmax@592 12 <script type="text/javascript" src="resize.js"></script>
flatmax@592 13 <script type="text/javascript" src="navtree.js"></script>
flatmax@592 14 <script type="text/javascript">
flatmax@592 15 $(document).ready(initResizable);
flatmax@592 16 </script>
flatmax@592 17 <link href="search/search.css" rel="stylesheet" type="text/css"/>
flatmax@592 18 <script type="text/javascript" src="search/search.js"></script>
flatmax@592 19 <script type="text/javascript">
flatmax@592 20 $(document).ready(function() { searchBox.OnSelectItem(0); });
flatmax@592 21 </script>
flatmax@592 22
flatmax@592 23 </head>
flatmax@592 24 <body>
flatmax@592 25 <div id="top"><!-- do not remove this div! -->
flatmax@592 26
flatmax@592 27
flatmax@592 28 <div id="titlearea">
flatmax@592 29 <table cellspacing="0" cellpadding="0">
flatmax@592 30 <tbody>
flatmax@592 31 <tr style="height: 56px;">
flatmax@592 32
flatmax@592 33 <td id="projectlogo"><img alt="Logo" src="icon.png"/></td>
flatmax@592 34
flatmax@592 35
flatmax@592 36 <td style="padding-left: 0.5em;">
flatmax@592 37 <div id="projectname">CARFAC C++
flatmax@592 38
flatmax@592 39 </div>
flatmax@592 40 <div id="projectbrief">C++ implementation of CARFAC</div>
flatmax@592 41 </td>
flatmax@592 42
flatmax@592 43
flatmax@592 44
flatmax@592 45 </tr>
flatmax@592 46 </tbody>
flatmax@592 47 </table>
flatmax@592 48 </div>
flatmax@592 49
flatmax@592 50 <!-- Generated by Doxygen 1.7.6.1 -->
flatmax@592 51 <script type="text/javascript">
flatmax@592 52 var searchBox = new SearchBox("searchBox", "search",false,'Search');
flatmax@592 53 </script>
flatmax@592 54 <div id="navrow1" class="tabs">
flatmax@592 55 <ul class="tablist">
flatmax@592 56 <li><a href="index.html"><span>Main&#160;Page</span></a></li>
flatmax@592 57 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
flatmax@592 58 <li><a href="files.html"><span>Files</span></a></li>
flatmax@592 59 <li>
flatmax@592 60 <div id="MSearchBox" class="MSearchBoxInactive">
flatmax@592 61 <span class="left">
flatmax@592 62 <img id="MSearchSelect" src="search/mag_sel.png"
flatmax@592 63 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@592 64 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@592 65 alt=""/>
flatmax@592 66 <input type="text" id="MSearchField" value="Search" accesskey="S"
flatmax@592 67 onfocus="searchBox.OnSearchFieldFocus(true)"
flatmax@592 68 onblur="searchBox.OnSearchFieldFocus(false)"
flatmax@592 69 onkeyup="searchBox.OnSearchFieldChange(event)"/>
flatmax@592 70 </span><span class="right">
flatmax@592 71 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
flatmax@592 72 </span>
flatmax@592 73 </div>
flatmax@592 74 </li>
flatmax@592 75 </ul>
flatmax@592 76 </div>
flatmax@592 77 <div id="navrow2" class="tabs2">
flatmax@592 78 <ul class="tablist">
flatmax@592 79 <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
flatmax@592 80 <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
flatmax@592 81 <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
flatmax@592 82 <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
flatmax@592 83 </ul>
flatmax@592 84 </div>
flatmax@592 85 </div>
flatmax@592 86 <div id="side-nav" class="ui-resizable side-nav-resizable">
flatmax@592 87 <div id="nav-tree">
flatmax@592 88 <div id="nav-tree-contents">
flatmax@592 89 </div>
flatmax@592 90 </div>
flatmax@592 91 <div id="splitbar" style="-moz-user-select:none;"
flatmax@592 92 class="ui-resizable-handle">
flatmax@592 93 </div>
flatmax@592 94 </div>
flatmax@592 95 <script type="text/javascript">
flatmax@592 96 initNavTree('classState.html','');
flatmax@592 97 </script>
flatmax@592 98 <div id="doc-content">
flatmax@592 99 <div class="header">
flatmax@592 100 <div class="summary">
flatmax@592 101 <a href="#pub-methods">Public Member Functions</a> </div>
flatmax@592 102 <div class="headertitle">
flatmax@592 103 <div class="title">State Class Reference</div> </div>
flatmax@592 104 </div><!--header-->
flatmax@592 105 <div class="contents">
flatmax@592 106 <!-- doxytag: class="State" -->
flatmax@592 107 <p><code>#include &lt;<a class="el" href="State_8H_source.html">State.H</a>&gt;</code></p>
flatmax@592 108 <div class="dynheader">
flatmax@592 109 Inheritance diagram for State:</div>
flatmax@592 110 <div class="dyncontent">
flatmax@592 111 <div class="center"><img src="classState__inherit__graph.png" border="0" usemap="#State_inherit__map" alt="Inheritance graph"/></div>
flatmax@592 112 <map name="State_inherit__map" id="State_inherit__map">
flatmax@592 113 <area shape="rect" id="node3" href="classAGCState.html" title="AGCState" alt="" coords="5,83,88,112"/><area shape="rect" id="node5" href="classCARState.html" title="CARState" alt="" coords="112,83,195,112"/><area shape="rect" id="node7" href="classIHCState.html" title="IHCState" alt="" coords="219,83,296,112"/></map>
flatmax@592 114 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
flatmax@592 115
flatmax@592 116 <p><a href="classState-members.html">List of all members.</a></p>
flatmax@592 117 <table class="memberdecls">
flatmax@592 118 <tr><td colspan="2"><h2><a name="pub-methods"></a>
flatmax@592 119 Public Member Functions</h2></td></tr>
flatmax@592 120 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classState.html#ab91bb1dd5aa6260ab2a456581daf9ec2">State</a> ()</td></tr>
flatmax@592 121 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classState.html#afab438d92b90dc18d194dbd9c9c8bab3">~State</a> ()</td></tr>
flatmax@592 122 </table>
flatmax@592 123 <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
flatmax@592 124 <div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@592 125 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08</dd></dl>
flatmax@592 126 <p>This class is common to 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. It provides virtual methods to give a common framework. </p>
flatmax@592 127 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
flatmax@592 128 <a class="anchor" id="ab91bb1dd5aa6260ab2a456581daf9ec2"></a><!-- doxytag: member="State::State" ref="ab91bb1dd5aa6260ab2a456581daf9ec2" args="()" -->
flatmax@592 129 <div class="memitem">
flatmax@592 130 <div class="memproto">
flatmax@592 131 <table class="memname">
flatmax@592 132 <tr>
flatmax@592 133 <td class="memname"><a class="el" href="classState.html#ab91bb1dd5aa6260ab2a456581daf9ec2">State::State</a> </td>
flatmax@592 134 <td>(</td>
flatmax@592 135 <td class="paramname"></td><td>)</td>
flatmax@592 136 <td></td>
flatmax@592 137 </tr>
flatmax@592 138 </table>
flatmax@592 139 </div>
flatmax@592 140 <div class="memdoc">
flatmax@592 141 <dl class="author"><dt><b>Author:</b></dt><dd>{Matt Flax &lt;flatmax@&gt;} </dd></dl>
flatmax@592 142 <dl class="date"><dt><b>Date:</b></dt><dd>2013.02.08 </dd></dl>
flatmax@592 143
flatmax@592 144 </div>
flatmax@592 145 </div>
flatmax@592 146 <a class="anchor" id="afab438d92b90dc18d194dbd9c9c8bab3"></a><!-- doxytag: member="State::~State" ref="afab438d92b90dc18d194dbd9c9c8bab3" args="()" -->
flatmax@592 147 <div class="memitem">
flatmax@592 148 <div class="memproto">
flatmax@592 149 <table class="memname">
flatmax@592 150 <tr>
flatmax@592 151 <td class="memname"><a class="el" href="classState.html#afab438d92b90dc18d194dbd9c9c8bab3">State::~State</a> </td>
flatmax@592 152 <td>(</td>
flatmax@592 153 <td class="paramname"></td><td>)</td>
flatmax@592 154 <td><code> [virtual]</code></td>
flatmax@592 155 </tr>
flatmax@592 156 </table>
flatmax@592 157 </div>
flatmax@592 158 <div class="memdoc">
flatmax@592 159
flatmax@592 160 </div>
flatmax@592 161 </div>
flatmax@592 162 <hr/>The documentation for this class was generated from the following files:<ul>
flatmax@592 163 <li><a class="el" href="State_8H_source.html">State.H</a></li>
flatmax@592 164 <li><a class="el" href="State_8C.html">State.C</a></li>
flatmax@592 165 </ul>
flatmax@592 166 </div><!-- contents -->
flatmax@592 167 </div>
flatmax@592 168 <!-- window showing the filter options -->
flatmax@592 169 <div id="MSearchSelectWindow"
flatmax@592 170 onmouseover="return searchBox.OnSearchSelectShow()"
flatmax@592 171 onmouseout="return searchBox.OnSearchSelectHide()"
flatmax@592 172 onkeydown="return searchBox.OnSearchSelectKey(event)">
flatmax@594 173 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Defines</a></div>
flatmax@592 174
flatmax@592 175 <!-- iframe showing the search results (closed by default) -->
flatmax@592 176 <div id="MSearchResultsWindow">
flatmax@592 177 <iframe src="javascript:void(0)" frameborder="0"
flatmax@592 178 name="MSearchResults" id="MSearchResults">
flatmax@592 179 </iframe>
flatmax@592 180 </div>
flatmax@592 181
flatmax@592 182 <div id="nav-path" class="navpath">
flatmax@592 183 <ul>
flatmax@592 184 <li class="navelem"><a class="el" href="classState.html">State</a> </li>
flatmax@592 185
flatmax@594 186 <li class="footer">Generated on Thu Feb 21 2013 09:31:11 for CARFAC C++ by
flatmax@592 187 <a href="http://www.doxygen.org/index.html">
flatmax@592 188 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
flatmax@592 189 </ul>
flatmax@592 190 </div>
flatmax@592 191
flatmax@592 192
flatmax@592 193 </body>
flatmax@592 194 </html>