diff options
author | Jens Lorenz <jlorenz@de.adit-jv.com> | 2018-02-13 09:47:57 +0100 |
---|---|---|
committer | Jens Lorenz <jlorenz@de.adit-jv.com> | 2018-02-13 11:06:03 +0100 |
commit | cc84de5b43ebd21e57b1411124fcc3a725bf6b88 (patch) | |
tree | a3ece549d48b4b15653b60102f6ea4bd4599f8b2 /docs/CAmRouter_8h.html | |
parent | 5b8411277e44e92eea3b8e9469af003415c02a6f (diff) | |
download | audiomanager-cc84de5b43ebd21e57b1411124fcc3a725bf6b88.tar.gz |
DOCS: Align documentation with version 7.6.6
Signed-off-by: Jens Lorenz <jlorenz@de.adit-jv.com>
Diffstat (limited to 'docs/CAmRouter_8h.html')
-rwxr-xr-x[-rw-r--r--] | docs/CAmRouter_8h.html | 94 |
1 files changed, 57 insertions, 37 deletions
diff --git a/docs/CAmRouter_8h.html b/docs/CAmRouter_8h.html index f243925..af5c4fd 100644..100755 --- a/docs/CAmRouter_8h.html +++ b/docs/CAmRouter_8h.html @@ -3,22 +3,24 @@ <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"/> +<meta name="generator" content="Doxygen 1.8.11"/> <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="navtreedata.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/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> - $(document).ready(function() { searchBox.OnSelectItem(0); }); + $(document).ready(function() { init_search(); }); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> @@ -28,9 +30,9 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> + <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">AudioManager -  <span id="projectnumber">7.5.11</span> +  <span id="projectnumber">7.6.6</span> </div> <div id="projectbrief">Native Application Runtime Environment</div> </td> @@ -39,7 +41,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.6 --> +<!-- Generated by Doxygen 1.8.11 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> @@ -47,6 +49,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <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="modules.html"><span>Modules</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> @@ -94,7 +97,7 @@ $(document).ready(function(){initNavTree('CAmRouter_8h.html','');}); 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> +</div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> @@ -116,56 +119,53 @@ $(document).ready(function(){initNavTree('CAmRouter_8h.html','');}); <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 class="textblock"><code>#include <assert.h></code><br /> +<code>#include <vector></code><br /> +<code>#include <iomanip></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="CAmDatabaseHandlerMap_8h_source.html">CAmDatabaseHandlerMap.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="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="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Implements 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="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> +<tr class="memitem:a9d70e10c712a8a908b5dc0d253955c25"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="CAmRouter_8h.html#a9d70e10c712a8a908b5dc0d253955c25">MAX_ROUTING_PATHS</a>   5</td></tr> +<tr class="memdesc:a9d70e10c712a8a908b5dc0d253955c25"><td class="mdescLeft"> </td><td class="mdescRight">Optimal path search is implemented with graph which contains nodes - sinks, sources, gateways, converters. <a href="#a9d70e10c712a8a908b5dc0d253955c25">More...</a><br /></td></tr> +<tr class="separator:a9d70e10c712a8a908b5dc0d253955c25"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1aacfba78a3f6aa3cb6514bb8b1458e3"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="CAmRouter_8h.html#a1aacfba78a3f6aa3cb6514bb8b1458e3">MAX_ALLOWED_DOMAIN_CYCLES</a>   1</td></tr> +<tr class="memdesc:a1aacfba78a3f6aa3cb6514bb8b1458e3"><td class="mdescLeft"> </td><td class="mdescRight">How many times the routing algorithm should look back into domains. <a href="#a1aacfba78a3f6aa3cb6514bb8b1458e3">More...</a><br /></td></tr> +<tr class="separator:a1aacfba78a3f6aa3cb6514bb8b1458e3"><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="memitem:af498e822629d2abed8233b798f29d1e4"><td class="memItemLeft" align="right" valign="top">typedef 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="memitem:a1f15203e131cc3a53fd57dae259ff67f"><td class="memItemLeft" align="right" valign="top">typedef CAmNode< 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="memitem:a8e5acf5a77b560755b3c47dc3e444126"><td class="memItemLeft" align="right" valign="top">typedef CAmGraph< am_RoutingNodeData_s, 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="memitem:abd263680f7c3d878c014187952bbbcf7"><td class="memItemLeft" align="right" valign="top">typedef CAmVertex< am_RoutingNodeData_s, 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="memitem:abcde4f3c2d4e51bca986488b88de323d"><td class="memItemLeft" align="right" valign="top">typedef std::list< 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="memitem:ae2d93bb8c081ecbf06b93ddb3dfbf34c"><td class="memItemLeft" align="right" valign="top">typedef std::vector< 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> @@ -181,17 +181,37 @@ Aleksandar Donchev, <a href="#" onclick="location.href='mai'+'lto:'+'Ale'+'ks'+' <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> +<a class="anchor" id="a1aacfba78a3f6aa3cb6514bb8b1458e3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">#define MAX_ALLOWED_DOMAIN_CYCLES   1</td> + </tr> + </table> +</div><div class="memdoc"> + +<p>How many times the routing algorithm should look back into domains. </p> +<p>0 - no cycles are allowed 1 - default is one cycle ... UINT_MAX - set this define to UINT_MAX in order to allow cycles. </p> + +<p>Definition at line <a class="el" href="CAmRouter_8h_source.html#l00068">68</a> of file <a class="el" href="CAmRouter_8h_source.html">CAmRouter.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a9d70e10c712a8a908b5dc0d253955c25"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">#define ROUTING_BUILD_CONNECTIONS   1</td> + <td class="memname">#define MAX_ROUTING_PATHS   5</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> +<p>Optimal path search is implemented with graph which contains nodes - sinks, sources, gateways, converters. </p> +<p>The nodes are identified by sinkID, sourceID, gatewayID, converterID. A possible connection between two nodes represents the facts that the nodes can be connected with one or more connectionFormats (Node[id=1] —> Node[id=2]). It is assumption that the two nodes can be connected. The controller itself decides later whether the connection is possible or not. Trace on/off. Max paths count returned to the controller </p> + +<p>Definition at line <a class="el" href="CAmRouter_8h_source.html#l00056">56</a> of file <a class="el" href="CAmRouter_8h_source.html">CAmRouter.h</a>.</p> </div> </div> @@ -201,9 +221,9 @@ Aleksandar Donchev, <a href="#" onclick="location.href='mai'+'lto:'+'Ale'+'ks'+' <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 + <li class="footer">Generated on Fri Feb 9 2018 14:50:30 for AudioManager by <a href="http://www.doxygen.org/index.html"> - <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li> </ul> </div> </body> |