diff options
author | Christian as GENIVI Maintainer <genivi-maint-audiomanager@genivi.org> | 2016-09-30 08:11:30 -0700 |
---|---|---|
committer | Christian as GENIVI Maintainer <genivi-maint-audiomanager@genivi.org> | 2016-09-30 08:11:30 -0700 |
commit | 1111f28e3693ee0f296819654a5c35fe147c395d (patch) | |
tree | f1e477707cd5b2c7abad162e23fdeddf5b276cdf /docs/CAmRouter_8h.html | |
parent | 0b8e04d293612d119227809fc678c90a39a51d3d (diff) | |
download | audiomanager-1111f28e3693ee0f296819654a5c35fe147c395d.tar.gz |
add doxygen documentation for github
Signed-off-by: Christian as GENIVI Maintainer <genivi-maint-audiomanager@genivi.org>
Diffstat (limited to 'docs/CAmRouter_8h.html')
-rw-r--r-- | docs/CAmRouter_8h.html | 210 |
1 files changed, 210 insertions, 0 deletions
diff --git a/docs/CAmRouter_8h.html b/docs/CAmRouter_8h.html new file mode 100644 index 0000000..f243925 --- /dev/null +++ b/docs/CAmRouter_8h.html @@ -0,0 +1,210 @@ +<!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"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>AudioManager: AudioManagerCore/include/CAmRouter.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="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); + $(window).load(resizeHeight); +</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">AudioManager +  <span id="projectnumber">7.5.11</span> + </div> + <div id="projectbrief">Native Application Runtime Environment</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<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><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</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 List</span></a></li> + <li><a href="globals.html"><span>File 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 id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('CAmRouter_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"> </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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</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="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#namespaces">Namespaces</a> | +<a href="#define-members">Macros</a> | +<a href="#typedef-members">Typedefs</a> </div> + <div class="headertitle"> +<div class="title">CAmRouter.h File Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>SPDX license identifier: MPL-2.0. +<a href="#details">More...</a></p> +<div class="textblock"><code>#include <assert.h></code><br/> +<code>#include <vector></code><br/> +<code>#include <functional></code><br/> +<code>#include "<a class="el" href="audiomanagertypes_8h_source.html">audiomanagertypes.h</a>"</code><br/> +<code>#include "<a class="el" href="CAmGraph_8h_source.html">CAmGraph.h</a>"</code><br/> +<code>#include "<a class="el" href="IAmDatabaseHandler_8h_source.html">IAmDatabaseHandler.h</a>"</code><br/> +</div> +<p><a href="CAmRouter_8h_source.html">Go to the source code of this file.</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structam_1_1am__RoutingNodeData__s.html">am::am_RoutingNodeData_s</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A structure used as user data in the graph nodes. <a href="structam_1_1am__RoutingNodeData__s.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classam_1_1CAmRouter.html">am::CAmRouter</a></td></tr> +<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Implements an autorouting algorithm for connecting sinks and sources via different audio domains. <a href="classam_1_1CAmRouter.html#details">More...</a><br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> +Namespaces</h2></td></tr> +<tr class="memitem:namespaceam"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceam.html">am</a></td></tr> +<tr class="memdesc:namespaceam"><td class="mdescLeft"> </td><td class="mdescRight">A Common-API wrapper class, which loads the common-api runtime and instantiates all necessary objects. <br/></td></tr> +<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> +Macros</h2></td></tr> +<tr class="memitem:aff729ebe1b45fb5af26288f42d61fd3b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="CAmRouter_8h.html#aff729ebe1b45fb5af26288f42d61fd3b">ROUTING_BUILD_CONNECTIONS</a>   1</td></tr> +<tr class="separator:aff729ebe1b45fb5af26288f42d61fd3b"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> +Typedefs</h2></td></tr> +<tr class="memitem:af498e822629d2abed8233b798f29d1e4"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/> +am_RoutingNodeData_s::am_NodeDataType_e </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceam.html#af498e822629d2abed8233b798f29d1e4">am::CAmNodeDataType</a></td></tr> +<tr class="separator:af498e822629d2abed8233b798f29d1e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1f15203e131cc3a53fd57dae259ff67f"><td class="memItemLeft" align="right" valign="top">typedef CAmNode<br class="typebreak"/> +< am_RoutingNodeData_s > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceam.html#a1f15203e131cc3a53fd57dae259ff67f">am::CAmRoutingNode</a></td></tr> +<tr class="separator:a1f15203e131cc3a53fd57dae259ff67f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a8e5acf5a77b560755b3c47dc3e444126"><td class="memItemLeft" align="right" valign="top">typedef CAmGraph<br class="typebreak"/> +< am_RoutingNodeData_s, <br class="typebreak"/> +uint16_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceam.html#a8e5acf5a77b560755b3c47dc3e444126">am::CAmRoutingGraph</a></td></tr> +<tr class="separator:a8e5acf5a77b560755b3c47dc3e444126"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abd263680f7c3d878c014187952bbbcf7"><td class="memItemLeft" align="right" valign="top">typedef CAmVertex<br class="typebreak"/> +< am_RoutingNodeData_s, <br class="typebreak"/> +uint16_t > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceam.html#abd263680f7c3d878c014187952bbbcf7">am::CAmRoutingVertex</a></td></tr> +<tr class="separator:abd263680f7c3d878c014187952bbbcf7"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:abcde4f3c2d4e51bca986488b88de323d"><td class="memItemLeft" align="right" valign="top">typedef std::list<br class="typebreak"/> +< CAmRoutingVertex > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceam.html#abcde4f3c2d4e51bca986488b88de323d">am::CAmRoutingListVertices</a></td></tr> +<tr class="separator:abcde4f3c2d4e51bca986488b88de323d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae2d93bb8c081ecbf06b93ddb3dfbf34c"><td class="memItemLeft" align="right" valign="top">typedef std::vector<br class="typebreak"/> +< CAmRoutingListVertices * > </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceam.html#ae2d93bb8c081ecbf06b93ddb3dfbf34c">am::CAmRoutingVertexReferenceList</a></td></tr> +<tr class="separator:ae2d93bb8c081ecbf06b93ddb3dfbf34c"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>SPDX license identifier: MPL-2.0. </p> +<p>Copyright (C) 2012, BMW AG</p> +<p>This file is part of GENIVI Project AudioManager.</p> +<p>Contributions are licensed to the GENIVI Alliance under one or more Contribution License Agreements.</p> +<dl class="section copyright"><dt>Copyright</dt><dd>This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>.</dd></dl> +<dl class="section author"><dt>Author</dt><dd>Christian Linke, <a href="#" onclick="location.href='mai'+'lto:'+'chr'+'is'+'tia'+'n.'+'lin'+'ke'+'@bm'+'w.'+'de'; return false;">chris<span style="display: none;">.nosp@m.</span>tian<span style="display: none;">.nosp@m.</span>.link<span style="display: none;">.nosp@m.</span>e@bm<span style="display: none;">.nosp@m.</span>w.de</a> BMW 2011,2012 </dd> +<dd> +Aleksandar Donchev, <a href="#" onclick="location.href='mai'+'lto:'+'Ale'+'ks'+'and'+'er'+'.Do'+'nc'+'hev'+'@p'+'art'+'ne'+'r.b'+'mw'+'.de'; return false;">Aleks<span style="display: none;">.nosp@m.</span>ande<span style="display: none;">.nosp@m.</span>r.Don<span style="display: none;">.nosp@m.</span>chev<span style="display: none;">.nosp@m.</span>@part<span style="display: none;">.nosp@m.</span>ner.<span style="display: none;">.nosp@m.</span>bmw.d<span style="display: none;">.nosp@m.</span>e</a> BMW 2013,2014</dd></dl> +<p>For further information see <a href="http://www.genivi.org/">http://www.genivi.org/</a>. </p> + +<p>Definition in file <a class="el" href="CAmRouter_8h_source.html">CAmRouter.h</a>.</p> +</div><h2 class="groupheader">Macro Definition Documentation</h2> +<a class="anchor" id="aff729ebe1b45fb5af26288f42d61fd3b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define ROUTING_BUILD_CONNECTIONS   1</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Definition at line <a class="el" href="CAmRouter_8h_source.html#l00038">38</a> of file <a class="el" href="CAmRouter_8h_source.html">CAmRouter.h</a>.</p> + +</div> +</div> +</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_73840c26962c025d9d91b16130beda5a.html">AudioManagerCore</a></li><li class="navelem"><a class="el" href="dir_a2790e911832141e38a92850240f8218.html">include</a></li><li class="navelem"><a class="el" href="CAmRouter_8h.html">CAmRouter.h</a></li> + <li class="footer">Generated on Fri Sep 30 2016 14:27:21 for AudioManager by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + </ul> +</div> +</body> +</html> |