diff options
Diffstat (limited to 'ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_ga57ca34a488f06d57f2219be23fa0259f.html')
-rw-r--r-- | ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_ga57ca34a488f06d57f2219be23fa0259f.html | 201 |
1 files changed, 0 insertions, 201 deletions
diff --git a/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_ga57ca34a488f06d57f2219be23fa0259f.html b/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_ga57ca34a488f06d57f2219be23fa0259f.html deleted file mode 100644 index 01bbe55..0000000 --- a/ucs2-lib/doc/html/group___g___u_c_s___r_o_u_t_i_n_g_ga57ca34a488f06d57f2219be23fa0259f.html +++ /dev/null @@ -1,201 +0,0 @@ -<!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>UNICENS: Ucs_Rm_SetNodeAvailable</title> -<link href="tabs.css" rel="stylesheet" type="text/css"/> -<link rel="shortcut icon" type="image/x-icon" href="favicon.ico"> -<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="style_html.css" rel="stylesheet" type="text/css" /> -<link href="inic.css" rel="stylesheet" type="text/css"/> -</head> -<body> -<div class="GlobalWrapper"> -<div id="top"><!-- do not remove this div, it is closed by doxygen! --> -<div id="titlearea"> -<table cellspacing="0" cellpadding="0"> - <tbody> - <tr> - <td><a href="index.html"><img alt="Logo" src="logo.png"/></a></td> - <td> - <div id="projectname">UNICENS <span id="projectnumber">V2.1.0-3491</span></div> - <div id="projectbrief">User Manual and API Reference</div> - <div id="searchbox"> <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> -</div> - </td> - </tr> - </tbody> -</table> -</div> -<!-- end header part --> -<!-- Generated by Doxygen 1.8.2 --> -<script type="text/javascript"> -var searchBox = new SearchBox("searchBox", "search",false,'Search'); -</script> -</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('group___g___u_c_s___r_o_u_t_i_n_g.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>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><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="contents"> -<a class="anchor" id="ga57ca34a488f06d57f2219be23fa0259f"></a> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd">Ucs_Return_t</a> Ucs_Rm_SetNodeAvailable </td> - <td>(</td> - <td class="paramtype"><a class="el" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga074c04d40d00986e0c869adaec8fadda.html#ga074c04d40d00986e0c869adaec8fadda">Ucs_Inst_t</a> * </td> - <td class="paramname"><em>self</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="struct_ucs___rm___node__t.html">Ucs_Rm_Node_t</a> * </td> - <td class="paramname"><em>node_ptr</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">bool </td> - <td class="paramname"><em>available</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Sets the availability attribute (<code>available</code> or <code>not</code> <code>available</code>) of the given node and triggers the routing process to handle attached route(s). </p> -<p>In case of <code>available</code> the function starts the routing process that checks whether there are endpoints to build on this node. In case of <code>unavailable</code> the function informs sub modules like XRM to check whether there are resources to release and simultaneously unlock <code>suspended</code> routes that link to this node. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">self</td><td>The UNICENS instance </td></tr> - <tr><td class="paramname">node_ptr</td><td>Reference to the node to be looked for. </td></tr> - <tr><td class="paramname">available</td><td>Specifies whether the node is available or not </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>Possible return values are shown in the table below. <table class="doxtable"> -<tr> -<th>Value </th><th>Description</th></tr> -<tr> -<td>UCS_RET_SUCCESS </td><td>No error </td></tr> -<tr> -<td>UCS_RET_ERR_ALREADY_SET </td><td>Node is already set to "available" or "not available" </td></tr> -<tr> -<td>UCS_RET_ERR_PARAM </td><td>At least one parameter is NULL. </td></tr> -<tr> -<td>UCS_RET_ERR_NOT_INITIALIZED </td><td>UNICENS is not initialized </td></tr> -<tr> -<td>UCS_RET_ERR_NOT_AVAILABLE </td><td>The function cannot be processed because the network is not available </td></tr> -</table> -</dd></dl> -<dl class="section note"><dt>Note</dt><dd>All nodes present in the routing system will be automatically set to <code>Unavailable</code> after the network has been shutdown respectively after transition from <code>Available</code> to <code>Not</code> <code>available</code>. This in turn means that the user has to set the corresponding nodes to <code>Available</code> after network started up respectively after the network transition from <code>NotAvailable</code> to <code>Available</code>.</dd></dl> -<p><br/> -<br/> -<b>Example</b> </p> -<div class="fragment"><div class="line"><span class="comment">// Sets the amplifier node to "available" or "not available"</span></div> -<div class="line"><span class="keyword">static</span> <span class="keywordtype">void</span> App_SetAmplNodeAvailability(<span class="keywordtype">bool</span> available)</div> -<div class="line">{</div> -<div class="line"> <a class="code" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#ga886138f5d13e84ffaa3df5769830e1cd" title="Standard return codes used for synchronous response.">Ucs_Return_t</a> ret_value;</div> -<div class="line"></div> -<div class="line"> ret_value = <a class="code" href="group___g___u_c_s___r_o_u_t_i_n_g_ga57ca34a488f06d57f2219be23fa0259f.html#ga57ca34a488f06d57f2219be23fa0259f" title="Sets the availability attribute (available or not available) of the given node and triggers the routi...">Ucs_Rm_SetNodeAvailable</a>(ucs_inst_ptr, &ampl_node, available);</div> -<div class="line"> <span class="keywordflow">if</span> (ret_value != <a class="code" href="group___g___u_c_s___i_n_i_t___a_n_d___s_r_v___t_y_p_e_s_ga886138f5d13e84ffaa3df5769830e1cd.html#gga886138f5d13e84ffaa3df5769830e1cda3fb51656e17ee4802f23706f35e349bc" title="Operation successfully completed.">UCS_RET_SUCCESS</a>)</div> -<div class="line"> {</div> -<div class="line"> <span class="comment">// Do whatever is necessary here</span></div> -<div class="line"> }</div> -<div class="line">}</div> -<div class="line"></div> -<div class="line"><span class="comment">// Main function</span></div> -<div class="line"><span class="keywordtype">void</span> main(uint8_t argc, <span class="keywordtype">char</span> *argv[])</div> -<div class="line">{</div> -<div class="line"> <span class="comment">// ...</span></div> -<div class="line"></div> -<div class="line"> <span class="keywordflow">if</span> (amplifier_programming_completed)</div> -<div class="line"> {</div> -<div class="line"> App_SetAmplNodeAvailability(<span class="keyword">true</span>);</div> -<div class="line"> }</div> -<div class="line"></div> -<div class="line"> <span class="comment">// ...</span></div> -<div class="line"></div> -<div class="line"> <span class="keywordflow">if</span> (amplifier_is_unavailable)</div> -<div class="line"> {</div> -<div class="line"> App_SetAmplNodeAvailability(<span class="keyword">false</span>); </div> -<div class="line"> }</div> -<div class="line">}</div> -</div><!-- fragment --> -</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="group___g___u_c_s___r_o_u_t_i_n_g.html">Routing Management</a></li> - <li class="footer">© 2017 Microchip Technology Inc. All rights reserved. <a href="http://www.microchip.com" target="_blank">www.microchip.com</a></li> - </ul> -</div> -</body> -<!-- -Generated on Mon Apr 3 2017 13:53:00 for UNICENS by -Doxygen 1.8.2 ---> -<script language="javascript"> -<!-- -$('#MSearchResults').wrap('<div style="position: absolute; margin-left: 444px;"></div>'); ---> -</script> -</html> |