Skip to content

Commit

Permalink
docs: Update OgreAPI documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@cstrobel-iis
cstrobel-iis committed Jul 27, 2020
1 parent 87421bd commit cf4cd53
Show file tree
Hide file tree
Showing 504 changed files with 19,447 additions and 12,403 deletions.
156 changes: 79 additions & 77 deletions docs/DataPilotMode_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,121 +2,123 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>DataPilotMode.h File Reference</title>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: DataPilotMode.h File Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
<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 id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">My Project
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</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 id="searchli">
<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>
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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="dir_93501a11e921083efbd154e0cdff5f10.html">packages</a></li><li class="navelem"><a class="el" href="dir_00f7798451e1ed98c99539181f468d4b.html">dataflow</a></li><li class="navelem"><a class="el" href="dir_26b6814fdfc41364a9c01ad22b1c961c.html">channel</a></li><li class="navelem"><a class="el" href="dir_a23f9bfab82cb655dfbdbc81e5f10d47.html">tracking</a></li><li class="navelem"><a class="el" href="dir_fc5139da126478b6bfcc3ce3a2a68b60.html">common</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> </div>
<div class="headertitle">
<div class="title">DataPilotMode.h File Reference</div> </div>
</div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="DataPilotMode_8h__dep__incl.png" border="0" usemap="#DataPilotMode_8hdep" alt=""/></div>
<map name="DataPilotMode_8hdep" id="DataPilotMode_8hdep">
<area shape="rect" id="node3" href="OgreControllerBackend_8h.html" title="OgreControllerBackend.h" alt="" coords="5,83,171,111"/></map>
<area shape="rect" id="node2" href="OgreControllerBackend_8h.html" title="OgreControllerBackend.h" alt="" coords="5,80,172,107"/>
</map>
</div>
</div>
<p><a href="DataPilotMode_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="enum-members"></a>
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43d">DataPilotMode</a> { <a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43da8f89fec354cc153623251e0eae33c030">DATA_ONLY</a> = 0,
<a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43dab66c9f3698065fcf54370f22307c052c">PILOT_ONLY</a> = 1,
<a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43daee368b06793f8e52a33b39e79aafccb5">DATA_PILOT</a> = 2,
<a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43da1d5efb780aaf92ad86378060caeadc7f">ALTBOC</a> = 3
<tr class="memitem:a7e6d6ef1258732cab94f17e62218e43d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43d">DataPilotMode</a> { <a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43da8f89fec354cc153623251e0eae33c030">DATA_ONLY</a> = 0,
<a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43dab66c9f3698065fcf54370f22307c052c">PILOT_ONLY</a> = 1,
<a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43daee368b06793f8e52a33b39e79aafccb5">DATA_PILOT</a> = 2,
<a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43da1d5efb780aaf92ad86378060caeadc7f">ALTBOC</a> = 3
}</td></tr>
<tr class="separator:a7e6d6ef1258732cab94f17e62218e43d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a7e6d6ef1258732cab94f17e62218e43d"></a><!-- doxytag: member="DataPilotMode.h::DataPilotMode" ref="a7e6d6ef1258732cab94f17e62218e43d" args="" -->
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a7e6d6ef1258732cab94f17e62218e43d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e6d6ef1258732cab94f17e62218e43d">&#9670;&nbsp;</a></span>DataPilotMode</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="DataPilotMode_8h.html#a7e6d6ef1258732cab94f17e62218e43d">DataPilotMode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
</div><div class="memdoc">
<p>Data/pilot mode selection for tracking. </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a7e6d6ef1258732cab94f17e62218e43da8f89fec354cc153623251e0eae33c030"></a><!-- doxytag: member="DATA_ONLY" ref="a7e6d6ef1258732cab94f17e62218e43da8f89fec354cc153623251e0eae33c030" args="" -->DATA_ONLY</em>&nbsp;</td><td>
<p>Data tracking only. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a7e6d6ef1258732cab94f17e62218e43dab66c9f3698065fcf54370f22307c052c"></a><!-- doxytag: member="PILOT_ONLY" ref="a7e6d6ef1258732cab94f17e62218e43dab66c9f3698065fcf54370f22307c052c" args="" -->PILOT_ONLY</em>&nbsp;</td><td>
<p>Pilot tracking, with data bit extraction from data signal </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7e6d6ef1258732cab94f17e62218e43da8f89fec354cc153623251e0eae33c030"></a>DATA_ONLY&#160;</td><td class="fielddoc"><p>Data tracking only. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a7e6d6ef1258732cab94f17e62218e43daee368b06793f8e52a33b39e79aafccb5"></a><!-- doxytag: member="DATA_PILOT" ref="a7e6d6ef1258732cab94f17e62218e43daee368b06793f8e52a33b39e79aafccb5" args="" -->DATA_PILOT</em>&nbsp;</td><td>
<p>Joint data - pilot tracking. NOT SUPPORTED YET. </p>
<tr><td class="fieldname"><a id="a7e6d6ef1258732cab94f17e62218e43dab66c9f3698065fcf54370f22307c052c"></a>PILOT_ONLY&#160;</td><td class="fielddoc"><p>Pilot tracking, with data bit extraction from data signal </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a7e6d6ef1258732cab94f17e62218e43da1d5efb780aaf92ad86378060caeadc7f"></a><!-- doxytag: member="ALTBOC" ref="a7e6d6ef1258732cab94f17e62218e43da1d5efb780aaf92ad86378060caeadc7f" args="" -->ALTBOC</em>&nbsp;</td><td>
<tr><td class="fieldname"><a id="a7e6d6ef1258732cab94f17e62218e43daee368b06793f8e52a33b39e79aafccb5"></a>DATA_PILOT&#160;</td><td class="fielddoc"><p>Joint data - pilot tracking. NOT SUPPORTED YET. </p>
</td></tr>
<tr><td class="fieldname"><a id="a7e6d6ef1258732cab94f17e62218e43da1d5efb780aaf92ad86378060caeadc7f"></a>ALTBOC&#160;</td><td class="fielddoc"></td></tr>
</table>
</dd>
</dl>

</div>
</div>
</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">&#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>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>

<hr class="footer"/><address class="footer"><small>Generated on Sat Jul 22 2017 17:08:52 by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/DataPilotMode_8h__dep__incl.map
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<map id="G" name="G">
<area shape="rect" id="node3" href="$OgreControllerBackend_8h.html" title="OgreControllerBackend.h" alt="" coords="5,83,171,111"/>
<map id="DataPilotMode.h" name="DataPilotMode.h">
<area shape="rect" id="node2" href="$OgreControllerBackend_8h.html" title="OgreControllerBackend.h" alt="" coords="5,80,172,107"/>
</map>
2 changes: 1 addition & 1 deletion docs/DataPilotMode_8h__dep__incl.md5
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
8b91a3d0fe638e50773943f5fdccbd6c
2e1782cf9100ab3ed84ef9b3203418e6
Binary file modified docs/DataPilotMode_8h__dep__incl.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit cf4cd53

Please sign in to comment.