summaryrefslogtreecommitdiffhomepage
path: root/Doc/doxygen/html/_power_8h_source.html
diff options
context:
space:
mode:
Diffstat (limited to 'Doc/doxygen/html/_power_8h_source.html')
-rw-r--r--Doc/doxygen/html/_power_8h_source.html179
1 files changed, 179 insertions, 0 deletions
diff --git a/Doc/doxygen/html/_power_8h_source.html b/Doc/doxygen/html/_power_8h_source.html
new file mode 100644
index 0000000..1ebb0a7
--- /dev/null
+++ b/Doc/doxygen/html/_power_8h_source.html
@@ -0,0 +1,179 @@
+<!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>Starshatter_Open: D:/SRC/StarshatterSVN/Stars45/Power.h Source File</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<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>
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 56px;">
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">Starshatter_Open
+ </div>
+ <div id="projectbrief">Open source Starshatter engine</div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.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&#160;Page</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>
+ <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="files.html"><span>File&#160;List</span></a></li>
+ <li><a href="globals.html"><span>File&#160;Members</span></a></li>
+ </ul>
+ </div>
+</div><!-- top -->
+<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">
+$(document).ready(function(){initNavTree('_power_8h.html','');});
+</script>
+<div id="doc-content">
+<!-- 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">&#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>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</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 class="header">
+ <div class="headertitle">
+<div class="title">Power.h</div> </div>
+</div><!--header-->
+<div class="contents">
+<a href="_power_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/* Project Starshatter 4.5</span></div>
+<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> Destroyer Studios LLC</span></div>
+<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> Copyright © 1997-2004. All Rights Reserved.</span></div>
+<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"></span></div>
+<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> SUBSYSTEM: Stars.exe</span></div>
+<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> FILE: Power.h</span></div>
+<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> AUTHOR: John DiCamillo</span></div>
+<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"></span></div>
+<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span></div>
+<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> OVERVIEW</span></div>
+<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> ========</span></div>
+<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> Power generation and usage classes</span></div>
+<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">*/</span></div>
+<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
+<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef Power_h</span></div>
+<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define Power_h</span></div>
+<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor"></span></div>
+<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_types_8h.html">Types.h</a>&quot;</span></div>
+<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_system_8h.html">System.h</a>&quot;</span></div>
+<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_list_8h.html">List.h</a>&quot;</span></div>
+<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;</div>
+<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment">// +--------------------------------------------------------------------+</span></div>
+<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
+<div class="line"><a name="l00024"></a><span class="lineno"><a class="code" href="class_power_source.html"> 24</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_power_source.html">PowerSource</a> : <span class="keyword">public</span> <a class="code" href="class_system.html">System</a></div>
+<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;{</div>
+<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="keyword">public</span>:</div>
+<div class="line"><a name="l00027"></a><span class="lineno"><a class="code" href="class_power_source.html#a0450af18dacd73d942ee423fe262626e"> 27</a></span>&#160; <span class="keyword">enum</span> <a class="code" href="class_power_source.html#a0450af18dacd73d942ee423fe262626e">SUBTYPE</a> { <a class="code" href="class_power_source.html#a0450af18dacd73d942ee423fe262626ead909751d33cb9d6f7dc1c94568134d14">BATTERY</a>, <a class="code" href="class_power_source.html#a0450af18dacd73d942ee423fe262626ea184ca17e5d378c3530d2022205274fb3">AUX</a>, <a class="code" href="class_power_source.html#a0450af18dacd73d942ee423fe262626ead6ff6d59a957cfba4b85d719ef0cebd6">FUSION</a> };</div>
+<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;</div>
+<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <a class="code" href="class_power_source.html#a6712e80506555003f8914345f5f057ae">PowerSource</a>(<a class="code" href="class_power_source.html#a0450af18dacd73d942ee423fe262626e">SUBTYPE</a> s, <span class="keywordtype">double</span> <a class="code" href="class_power_source.html#abea4470e118dfac663748ab6253d678e">max_output</a>, <span class="keywordtype">double</span> <a class="code" href="class_power_source.html#a5d547941ef76a9fc691296aec4c7c0d6">fuel_ratio</a>=0);</div>
+<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="class_power_source.html#a6712e80506555003f8914345f5f057ae">PowerSource</a>(<span class="keyword">const</span> <a class="code" href="class_power_source.html">PowerSource</a>&amp; rhs);</div>
+<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div>
+<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_power_source.html#a8fb430e6956aa862d0809fc8ba14e806">ExecFrame</a>(<span class="keywordtype">double</span> seconds);</div>
+<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;</div>
+<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_power_source.html#a59abc86f4802c51cfdbd0103240e8761">AddClient</a>(<a class="code" href="class_system.html">System</a>* client);</div>
+<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_power_source.html#a54e64eed70609c53cfebc7b449a848c2">RemoveClient</a>(<a class="code" href="class_system.html">System</a>* client);</div>
+<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div>
+<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="class_power_source.html#a0d1d4623852db43525c3b10ca00ecede"> 37</a></span>&#160; <a class="code" href="class_list.html">List&lt;System&gt;</a>&amp; <a class="code" href="class_power_source.html#a0d1d4623852db43525c3b10ca00ecede">Clients</a>() { <span class="keywordflow">return</span> <a class="code" href="class_power_source.html#a3d0fcb4ab7a5ec052d890af52badaae6">clients</a>; }</div>
+<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
+<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="class_power_source.html#a17b3ebb45f9f236dbabb8ffc2be5d3f4">Charge</a>() <span class="keyword">const</span>;</div>
+<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
+<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_power_source.html#aad8e003175d8bbe0b10cb79854e665f4">SetFuelRange</a>(<span class="keywordtype">double</span> hours);</div>
+<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
+<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="class_power_source.html#ae400439bc5754cdbc406cd114c0d338b"> 43</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_power_source.html#ae400439bc5754cdbc406cd114c0d338b">RouteChanged</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <a class="code" href="class_power_source.html#aac4f3f90138ba027baed42f5fcbe950e">route_changed</a>; }</div>
+<div class="line"><a name="l00044"></a><span class="lineno"><a class="code" href="class_power_source.html#acce01d24faf5604aae89980f928ad9d6"> 44</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="class_power_source.html#acce01d24faf5604aae89980f928ad9d6">RouteScanned</a>() { <a class="code" href="class_power_source.html#aac4f3f90138ba027baed42f5fcbe950e">route_changed</a> = <span class="keyword">false</span>; }</div>
+<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
+<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// override from System:</span></div>
+<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_power_source.html#a0095ec7d60072b5e80cce5348119ef3c">SetPowerLevel</a>(<span class="keywordtype">double</span> level);</div>
+<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_power_source.html#a3d538f45dd14f5c8d8ae3bc0328a84b6">SetOverride</a>(<span class="keywordtype">bool</span> over);</div>
+<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;</div>
+<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="comment">// for power drain damage:</span></div>
+<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_power_source.html#a0c789035393e2758183321b577aea9e0">DrainPower</a>(<span class="keywordtype">double</span> to_level);</div>
+<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
+<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="keyword">protected</span>:</div>
+<div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="class_power_source.html#abea4470e118dfac663748ab6253d678e"> 54</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="class_power_source.html#abea4470e118dfac663748ab6253d678e">max_output</a>;</div>
+<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="class_power_source.html#a5d547941ef76a9fc691296aec4c7c0d6"> 55</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="class_power_source.html#a5d547941ef76a9fc691296aec4c7c0d6">fuel_ratio</a>;</div>
+<div class="line"><a name="l00056"></a><span class="lineno"><a class="code" href="class_power_source.html#a3d0fcb4ab7a5ec052d890af52badaae6"> 56</a></span>&#160; <a class="code" href="class_list.html">List&lt;System&gt;</a> <a class="code" href="class_power_source.html#a3d0fcb4ab7a5ec052d890af52badaae6">clients</a>;</div>
+<div class="line"><a name="l00057"></a><span class="lineno"><a class="code" href="class_power_source.html#aac4f3f90138ba027baed42f5fcbe950e"> 57</a></span>&#160; <span class="keywordtype">bool</span> <a class="code" href="class_power_source.html#aac4f3f90138ba027baed42f5fcbe950e">route_changed</a>;</div>
+<div class="line"><a name="l00058"></a><span class="lineno"><a class="code" href="class_power_source.html#a5f1fb304ec707f2efa2ff6337a084259"> 58</a></span>&#160; <span class="keywordtype">float</span> <a class="code" href="class_power_source.html#a5f1fb304ec707f2efa2ff6337a084259">requested_power_level</a>;</div>
+<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;};</div>
+<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div>
+<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#endif Power_h</span></div>
+<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;<span class="preprocessor"></span></div>
+</div><!-- fragment --></div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+ <ul>
+ <li class="navelem"><a class="el" href="dir_ea1b58c809a5070716d7c602998a95b0.html">Stars45</a></li><li class="navelem"><a class="el" href="_power_8h.html">Power.h</a></li>
+ <li class="footer">Generated on Thu May 31 2012 16:31:14 for Starshatter_Open by
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li>
+ </ul>
+</div>
+</body>
+</html>