INTRODUCTION
Overview
Download and Install
Documentation
Publications

REPOSITORY
Libraries

DEVELOPER
Dev Guide
Dashboard

PEOPLE
Contributors
Users

SourceForge.net Logo
Project
Download
Mailing lists

 

         

gbxutilacfr::SubStatus Class Reference

Convenience class which represents the status of a subsystem. More...

#include <substatus.h>

List of all members.

Public Member Functions

 SubStatus (Status &status, const std::string &subsystem)
 ~SubStatus ()
 Removes this subsystem from the system.
void setMaxHeartbeatInterval (double interval)
 Passes this information to the system Status.
void heartbeat ()
 Passes this information to the system Status.
void initialising (const std::string &message="")
 Passes this information to the system Status.
void ok (const std::string &message="")
 Passes this information to the system Status.
void warning (const std::string &message)
 Passes this information to the system Status.
void fault (const std::string &message)
 Passes this information to the system Status.
std::string name () const
 Returns subsystem's name.


Detailed Description

Convenience class which represents the status of a subsystem.

Overview
SubStatus provides a machine-readable interface such that other components can monitor this component's status.

A single SubStatus object is meant to be shared by all threads in the component so the implementation must be thread-safe.

See also:
SubStatus


Constructor & Destructor Documentation

gbxutilacfr::SubStatus::SubStatus ( Status status,
const std::string &  subsystem 
) [inline]

Sets a reference to the system Status and this subsystem's name. Adds this subsystem to the system with default (infinite) maximum heartbeat interval.


The documentation for this class was generated from the following file:
 

Generated for GearBox by  doxygen 1.4.5