<!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_1SubStatus.html">SubStatus</a>
</div>
</div>
<div class="contents">
<h1>gbxutilacfr::SubStatus Class Reference</h1><!-- doxytag: class="gbxutilacfr::SubStatus" -->
<p>Convenience class which maniupulates the status of a subsystem.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="substatus_8h_source.html">substatus.h</a>></code></p>
<p><a href="classgbxutilacfr_1_1SubStatus-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_1SubStatus.html#aa1e74ff50587383c417392acf28eb456">SubStatus</a> (<a class="el" href="classgbxutilacfr_1_1Status.html">Status</a> &status, const std::string &subsysName, double maxHeartbeatIntervalSec=-1.0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac15313ce52a83008a43b3230a4cb6222"></a><!-- doxytag: member="gbxutilacfr::SubStatus::~SubStatus" ref="ac15313ce52a83008a43b3230a4cb6222" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#ac15313ce52a83008a43b3230a4cb6222">~SubStatus</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Removes this subsystem from the system. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e78399a8fb322a4bc1e188c4b007400"></a><!-- doxytag: member="gbxutilacfr::SubStatus::setMaxHeartbeatInterval" ref="a4e78399a8fb322a4bc1e188c4b007400" args="(double interval)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#a4e78399a8fb322a4bc1e188c4b007400">setMaxHeartbeatInterval</a> (double interval)</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="ac4b3a2cad961a7a91fbe525008ef226a"></a><!-- doxytag: member="gbxutilacfr::SubStatus::setSubsystemType" ref="ac4b3a2cad961a7a91fbe525008ef226a" args="(SubsystemType type)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#ac4b3a2cad961a7a91fbe525008ef226a">setSubsystemType</a> (<a class="el" href="namespacegbxutilacfr.html#a83955362590d05dc433ff5ba377a704b">SubsystemType</a> type)</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="a5604e9434630cf86af4413de0f9942c9"></a><!-- doxytag: member="gbxutilacfr::SubStatus::heartbeat" ref="a5604e9434630cf86af4413de0f9942c9" args="()" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#a5604e9434630cf86af4413de0f9942c9">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="aeb3ccd98bbd8538f25e025c92a55795d"></a><!-- doxytag: member="gbxutilacfr::SubStatus::message" ref="aeb3ccd98bbd8538f25e025c92a55795d" args="(const std::string &message)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#aeb3ccd98bbd8538f25e025c92a55795d">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="a0620674f75ac8ef16360d4b3471b3c78"></a><!-- doxytag: member="gbxutilacfr::SubStatus::ok" ref="a0620674f75ac8ef16360d4b3471b3c78" args="(const std::string &message="")" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#a0620674f75ac8ef16360d4b3471b3c78">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="afe967684ec3aa20ad063a1bbcfc5508b"></a><!-- doxytag: member="gbxutilacfr::SubStatus::warning" ref="afe967684ec3aa20ad063a1bbcfc5508b" args="(const std::string &message)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#afe967684ec3aa20ad063a1bbcfc5508b">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="a9a6d1cefde68c7df53a63fe580d2b53c"></a><!-- doxytag: member="gbxutilacfr::SubStatus::fault" ref="a9a6d1cefde68c7df53a63fe580d2b53c" args="(const std::string &message)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#a9a6d1cefde68c7df53a63fe580d2b53c">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="af527b7dfaffc05d73d2d5d10e79e32f6"></a><!-- doxytag: member="gbxutilacfr::SubStatus::initialising" ref="af527b7dfaffc05d73d2d5d10e79e32f6" args="(const std::string &message="")" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#af527b7dfaffc05d73d2d5d10e79e32f6">initialising</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="ab9ec3cced0be787a7a4fd3a9ede9bf70"></a><!-- doxytag: member="gbxutilacfr::SubStatus::working" ref="ab9ec3cced0be787a7a4fd3a9ede9bf70" args="(const std::string &message="")" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#ab9ec3cced0be787a7a4fd3a9ede9bf70">working</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="a46b27f8be5d7ef5ab80d520b72120323"></a><!-- doxytag: member="gbxutilacfr::SubStatus::finalising" ref="a46b27f8be5d7ef5ab80d520b72120323" args="(const std::string &message="")" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#a46b27f8be5d7ef5ab80d520b72120323">finalising</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="a6378494b04bda11ca73f1b78f96107f9"></a><!-- doxytag: member="gbxutilacfr::SubStatus::status" ref="a6378494b04bda11ca73f1b78f96107f9" args="()" -->
<a class="el" href="classgbxutilacfr_1_1Status.html">Status</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#a6378494b04bda11ca73f1b78f96107f9">status</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns system <a class="el" href="classgbxutilacfr_1_1Status.html" title="Local interface to component status.">Status</a> object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a13301a0999cbbe7edebf2988f30262f7"></a><!-- doxytag: member="gbxutilacfr::SubStatus::name" ref="a13301a0999cbbe7edebf2988f30262f7" args="() const " -->
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classgbxutilacfr_1_1SubStatus.html#a13301a0999cbbe7edebf2988f30262f7">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 maniupulates the status of a subsystem. </p>
<dl class="user"><dt><b>Overview</b></dt><dd></dd></dl>
<p>Provides a convenient interface for setting status 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>, </dd>
<dd>
<a class="el" href="classgbxutilacfr_1_1SubHealth.html" title="Convenience class which allows feedback on the health of a subsystem.">SubHealth</a> </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aa1e74ff50587383c417392acf28eb456"></a><!-- doxytag: member="gbxutilacfr::SubStatus::SubStatus" ref="aa1e74ff50587383c417392acf28eb456" args="(Status &status, const std::string &subsysName, double maxHeartbeatIntervalSec=-1.0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gbxutilacfr::SubStatus::SubStatus </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classgbxutilacfr_1_1Status.html">Status</a> & </td>
<td class="paramname"> <em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>subsysName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>maxHeartbeatIntervalSec</em> = <code>-1.0</code></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="substatus_8h_source.html">substatus.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>
