substatus.h

/*
 * GearBox Project: Peer-Reviewed Open-Source Libraries for Robotics
 *               http://gearbox.sf.net/
 * Copyright (c) 2004-2010 Alex Brooks, Alexei Makarenko, Tobias Kaupp
 *
 * This distribution is licensed to you under the terms described in
 * the LICENSE file included in this distribution.
 *
 */

#ifndef GBXUTILACFR_SUBSYSTEM_STATUS_H
#define GBXUTILACFR_SUBSYSTEM_STATUS_H

#if defined (WIN32)
    #if defined (GBXUTILACFR_STATIC)
        #define GBXUTILACFR_EXPORT
    #elif defined (GBXUTILACFR_EXPORTS)
        #define GBXUTILACFR_EXPORT       __declspec (dllexport)
    #else
        #define GBXUTILACFR_EXPORT       __declspec (dllimport)
    #endif
#else
    #define GBXUTILACFR_EXPORT
#endif

#include <gbxutilacfr/status.h>

namespace gbxutilacfr {

class GBXUTILACFR_EXPORT SubStatus
{

public:
    SubStatus( Status& status, const std::string& subsysName, double maxHeartbeatIntervalSec=-1.0 ) :
        status_(status),
        subsysName_(subsysName)
    {
        status_.addSubsystem( subsysName_, maxHeartbeatIntervalSec );
    };

    ~SubStatus();

    //
    // set expectations about ourselves
    //

    void setMaxHeartbeatInterval( double interval ) { status_.setMaxHeartbeatInterval( subsysName_, interval ); };

    void setSubsystemType( SubsystemType type ) { status_.setSubsystemType( subsysName_, type ); };

    //
    // set health
    //

    void heartbeat() { status_.heartbeat( subsysName_ ); };

    void message( const std::string& message ) { status_.message( subsysName_, message ); };

    void ok( const std::string& message="" ) { status_.ok( subsysName_, message ); };

    void warning( const std::string& message ) { status_.warning( subsysName_, message ); };

    void critical( const std::string& message ) { status_.critical( subsysName_, message ); };

    //
    // Set state machine states
    //

    void initialising() { status_.initialising( subsysName_ ); };

    void working() { status_.working( subsysName_ ); };

    void finalising() { status_.finalising( subsysName_ ); };

    void fault( const std::string& message ) { status_.fault( subsysName_, message ); };

    Status& status() { return status_; };

    std::string name() const { return subsysName_; };

private:

    // Make this uncopyable
    SubStatus(const SubStatus&);
    void operator=(const SubStatus&);

    Status& status_;
    std::string subsysName_;
};

} // namespace

#endif