<!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>GearBox Project</title> <link rel="icon" href="gbx_icon_cardbox_sky.png" type="image/png"> <link rel="shortcut icon" href="gbx_icon_cardbox_sky.png" type="image/png"> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> <!-- Google Analytics --> <script type="text/javascript"> var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); </script> <script type="text/javascript"> var pageTracker = _gat._getTracker("UA-3583782-1"); pageTracker._initData(); pageTracker._trackPageview(); </script> <!-- Returning you to your regular programming --> </head><body> <!-- Header --> <table border="0" cellspacing="0" cellpadding="0"> <tr><!-- create row --> <!-- spacer cell --> <!-- #CC CC CC --> <td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td> <!-- menu cell --> <td width="170" rowspan="1" colspan="1" align="left" valign="top" bgcolor="#EEEEEE"> <p> </p> <p align="center"><a href="index.html"><img src="gbx_logo_cardbox_sky_150x150.png"></a></p><br> <strong>INTRODUCTION</strong><br> <strong><a href="gbx_doc_overview.html" style="text-decoration:none">Overview</a></strong><br> <strong><a href="gbx_doc_getting.html" style="text-decoration:none">Download and Install</a></strong><br> <!-- <strong><a href="gbx_doc_quickstart.html" style="text-decoration:none">Quick Start</a></strong><br> --> <strong><a href="gbx_doc_documentation.html" style="text-decoration:none">Documentation</a></strong><br> <strong><a href="gbx_doc_publications.html" style="text-decoration:none">Publications</a></strong><br> <br> <strong>REPOSITORY</strong><br> <strong><a href="group__gbx__libs.html" style="text-decoration:none">Libraries</a></strong><br> <!-- <strong><a href="group__gbx__utils.html" style="text-decoration:none">Utilities</a></strong><br> --> <br> <strong>DEVELOPER</strong><br> <!--<strong><a href="gbx_doc_tutorials.html" style="text-decoration:none">Tutorials</a></strong><br> <strong><a href="group__gbx__examples.html" style="text-decoration:none">Examples</a></strong><br>--> <strong><a href="gbx_doc_devguide.html" style="text-decoration:none">Dev Guide</a></strong><br> <!-- <strong><a href="gbx_doc_faq.html" style="text-decoration:none">FAQ</a></strong><br> --> <strong><a href="http://cdash.acfr.usyd.edu.au/index.php?project=Gearbox" style="text-decoration:none">Dashboard</a></strong><br> <!--<strong><a href="http://wiki2.cas.edu.au/orca">Wiki</a></strong><br> login/pass: orca/orca<br>--> <br> <strong>PEOPLE</strong><br> <strong><a href="gbx_doc_contributors.html" style="text-decoration:none">Contributors</a></strong><br> <strong><a href="gbx_doc_users.html" style="text-decoration:none">Users</a></strong><br> <br> <a href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=216468&type=2" width="125" height="37" border="0" alt="SourceForge.net Logo" /></a><br> <strong><a href="http://sourceforge.net/projects/gearbox">Project</a></strong><br> <strong><a href="http://sourceforge.net/project/showfiles.php?group_id=216468">Download</a></strong><br> <!--<strong><a href="http://sourceforge.net/tracker/?group_id=216468">Bugs/Feedback</a></strong><br>--> <strong><a href="http://sourceforge.net/mail/?group_id=216468">Mailing lists</a></strong></p> <p> </p> </td><!-- /menu cell --> <!-- one grey spacer cells --> <td rowspan="1" colspan="1" bgcolor="#EEEEEE"> </td> <!-- one white spacer cells --> <td rowspan="1" colspan="1"> </td> <!-- main content cell --> <td rowspan="1" colspan="1" align="left" valign="top"> <!-- Generated by Doxygen 1.6.2-20100208 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <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 class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacegbxutilacfr.html">gbxutilacfr</a>::<a class="el" href="classgbxutilacfr_1_1SubHealth.html">SubHealth</a> </div> </div> <div class="contents"> <h1>gbxutilacfr::SubHealth Class Reference</h1><!-- doxytag: class="gbxutilacfr::SubHealth" --> <p>Convenience class which allows feedback on the health of a subsystem. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="subhealth_8h_source.html">subhealth.h</a>></code></p> <p><a href="classgbxutilacfr_1_1SubHealth-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubHealth.html#a4d5a50939feaa6595e696309d477cfb7">SubHealth</a> (<a class="el" href="classgbxutilacfr_1_1Status.html">Status</a> &sysStatus, const std::string &subsysName)</td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6ffa8dfc68f8cd4b5f0b0a1000ea3f8e"></a><!-- doxytag: member="gbxutilacfr::SubHealth::heartbeat" ref="a6ffa8dfc68f8cd4b5f0b0a1000ea3f8e" args="()" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubHealth.html#a6ffa8dfc68f8cd4b5f0b0a1000ea3f8e">heartbeat</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Passes this information to the system <a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">Status</a>. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf46f7965e42e61a5a4074267cb99285"></a><!-- doxytag: member="gbxutilacfr::SubHealth::message" ref="acf46f7965e42e61a5a4074267cb99285" args="(const std::string &message)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubHealth.html#acf46f7965e42e61a5a4074267cb99285">message</a> (const std::string &message)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Passes this information to the system <a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">Status</a>. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfb688887b935f6e3027e777172b97d0"></a><!-- doxytag: member="gbxutilacfr::SubHealth::ok" ref="abfb688887b935f6e3027e777172b97d0" args="(const std::string &message="")" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubHealth.html#abfb688887b935f6e3027e777172b97d0">ok</a> (const std::string &message="")</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Passes this information to the system <a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">Status</a>. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acca9a841ba2710e019f6cfc5804ffb4d"></a><!-- doxytag: member="gbxutilacfr::SubHealth::warning" ref="acca9a841ba2710e019f6cfc5804ffb4d" args="(const std::string &message)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubHealth.html#acca9a841ba2710e019f6cfc5804ffb4d">warning</a> (const std::string &message)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Passes this information to the system <a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">Status</a>. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af17357c216b0f81ac06611fea48cc987"></a><!-- doxytag: member="gbxutilacfr::SubHealth::fault" ref="af17357c216b0f81ac06611fea48cc987" args="(const std::string &message)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubHealth.html#af17357c216b0f81ac06611fea48cc987">fault</a> (const std::string &message)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Passes this information to the system <a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">Status</a>. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8c086cc949cccb0b87bb10c9cf465c00"></a><!-- doxytag: member="gbxutilacfr::SubHealth::name" ref="a8c086cc949cccb0b87bb10c9cf465c00" args="() const " --> std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubHealth.html#a8c086cc949cccb0b87bb10c9cf465c00">name</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns subsystem's name. <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Convenience class which allows feedback on the health of a subsystem. </p> <dl class="user"><dt><b>Overview</b></dt><dd></dd></dl> <p>Provides a convenient interface for setting health information for one subsystem.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">Status</a>, <a class="el" href="structgbxutilacfr_1_1SubsystemStatus.html" title="Status for a single subsystem.">SubsystemStatus</a> </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a4d5a50939feaa6595e696309d477cfb7"></a><!-- doxytag: member="gbxutilacfr::SubHealth::SubHealth" ref="a4d5a50939feaa6595e696309d477cfb7" args="(Status &sysStatus, const std::string &subsysName)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">gbxutilacfr::SubHealth::SubHealth </td> <td>(</td> <td class="paramtype"><a class="el" href="classgbxutilacfr_1_1Status.html">Status</a> & </td> <td class="paramname"> <em>sysStatus</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::string & </td> <td class="paramname"> <em>subsysName</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Sets a reference to the system <a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">Status</a> and this subsystem's name. Adds this subsystem to the system. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="subhealth_8h_source.html">subhealth.h</a></li> </ul> </div> </td> <td colspan="1"> </td> </tr> </table> <!-- end of table --> <hr size="1"><address style="align: right;"><small>Generated for GearBox by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address> </body> </html>