📄 energy_8h.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>BlueLab: energy.h File Reference</title><link href="doxygen.css" rel="stylesheet" type="text/css"></head><body><!-- Generated by Doxygen 1.3.8 --><div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div><h1>energy.h File Reference</h1>Estimate the energy in a SCO connection. <a href="#_details">More...</a><p><h2>Functions</h2><ul><li><a class="el" href="csrtypes_8h.html#a9">bool</a> <a class="el" href="energy_8h.html#a0">EnergyEstimationOn</a> (<a class="el" href="sink___8h.html#a0">Sink</a> sco, <a class="el" href="csrtypes_8h.html#a4">uint16</a> greater, <a class="el" href="csrtypes_8h.html#a4">uint16</a> threshold)<dl class="el"><dd class="mdescRight">Turn on energy estimation on the given SCO connection. <a href="#a0"></a><br></dl><li><a class="el" href="csrtypes_8h.html#a9">bool</a> <a class="el" href="energy_8h.html#a1">EnergyEstimationOff</a> (<a class="el" href="sink___8h.html#a0">Sink</a> sco)<dl class="el"><dd class="mdescRight">Disable estimation on the specified SCO connection. <a href="#a1"></a><br></dl></ul><hr><a name="_details"></a><h2>Detailed Description</h2>Estimate the energy in a SCO connection. <p><hr><h2>Function Documentation</h2><a class="anchor" name="a0" doxytag="energy.h::EnergyEstimationOn" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a9">bool</a> EnergyEstimationOn </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a> </td> <td class="mdname" nowrap> <em>sco</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname" nowrap> <em>greater</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td></td> <td class="md" nowrap><a class="el" href="csrtypes_8h.html#a4">uint16</a> </td> <td class="mdname" nowrap> <em>threshold</em></td> </tr> <tr> <td></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Turn on energy estimation on the given SCO connection. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>sco</em> </td><td>The SCO stream to enable energy estimation on. </td></tr> <tr><td></td><td valign=top><em>greater</em> </td><td>If TRUE then a message will be send if SCO energy exceeds threshold. Else a message will be sent if SCO energy falls below threshold. </td></tr> <tr><td></td><td valign=top><em>threshold</em> </td><td>The energy threshold to use.</td></tr> </table></dl>One MESSAGE_ENERGY_CHANGED message will be sent to the task associated with the SCO stream when the threshold is passed in the given direction. The task must then reenable the energy estimation if it wishes to receive further messages.<p>Estimation is automatically stopped when the SCO connection is closed.<p>Returns FALSE if the sink does not correspond to a SCO connection. </td> </tr></table><a class="anchor" name="a1" doxytag="energy.h::EnergyEstimationOff" ></a><p><table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> <a class="el" href="csrtypes_8h.html#a9">bool</a> EnergyEstimationOff </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="sink___8h.html#a0">Sink</a> </td> <td class="mdname1" valign="top" nowrap> <em>sco</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr></table><table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td><p>Disable estimation on the specified SCO connection. <p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign=top><em>sco</em> </td><td>The SCO connection to disable energy estimation on.</td></tr> </table></dl>Returns FALSE if the sink does not correspond to a SCO connection. </td> </tr></table></body></html>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -