Mercurial > hg > aimc

comparison trunk/C++/api/html/classState.html @ 597:359bcd461dd1

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