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 maniupulates the status of a subsystem. More...

#include <substatus.h>

Public Member Functions

 SubStatus (Status &status, const std::string &subsysName, double maxHeartbeatIntervalSec=-1.0)
 
 ~SubStatus ()
 Removes this subsystem from the system.
 
void setMaxHeartbeatInterval (double interval)
 Passes this information to the system Status.
 
void setSubsystemType (SubsystemType type)
 Passes this information to the system Status.
 
void heartbeat ()
 Passes this information to the system Status.
 
void message (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. Diagnostic message is required.
 
void critical (const std::string &message)
 Passes this information to the system Status. Diagnostic message is required.
 
void initialising ()
 Passes this information to the system Status.
 
void working ()
 Passes this information to the system Status.
 
void finalising ()
 Passes this information to the system Status.
 
void fault (const std::string &message)
 Passes this information to the system Status. Diagnostic message is required.
 
Statusstatus ()
 Returns system Status object.
 
std::string name () const
 Returns subsystem's name.
 

Detailed Description

Convenience class which maniupulates the status of a subsystem.

Overview

Provides a convenient interface for setting status information for one subsystem.

See also
Status,
SubHealth

Constructor & Destructor Documentation

◆ SubStatus()

gbxutilacfr::SubStatus::SubStatus ( Status status,
const std::string &  subsysName,
double  maxHeartbeatIntervalSec = -1.0 
)
inline

Sets a reference to the system Status and this subsystem's name. Adds this subsystem to the system.


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

Generated for GearBox by  doxygen 1.4.5