---

sgnlman.h

Go to the documentation of this file.

#ifndef __SGNLMAN_H_INCLUDED__
#define __SGNLMAN_H_INCLUDED__

// $Id$

//**********************************************************************
//                                                                     *
//    Description:   'Bell Master' Signalman class.                    *
//                                                                     *
//    Author:        Chris White (whitecf@bcs.org.uk)                  *
//                                                                     *
//    Copyright (C) 2003  Monitor Computing Services Ltd.              *
//                                                                     *
//    This program is free software; you can redistribute it and/or    *
//    modify it under the terms of the GNU General Public License      *
//    as published by the Free Software Foundation; either version 2   *
//    of the License, or any later version.                            *
//                                                                     *
//    This program is distributed in the hope that it will be useful,  *
//    but WITHOUT ANY WARRANTY; without even the implied warranty of   *
//    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
//    GNU General Public License for more details.                     *
//                                                                     *
//    You should have received a copy of the GNU General Public        *
//    License (http://www.gnu.org/copyleft/gpl.html) along with this   *
//    program; if not, write to:                                       *
//       The Free Software Foundation Inc.,                            *
//       59 Temple Place - Suite 330,                                  *
//       Boston, MA  02111-1307,                                       *
//       USA.                                                          *
//                                                                     *
//**********************************************************************
//                                                                     *
//    Notes:                                                           *
//                                                                     *
//**********************************************************************

#include <cstring.h>

namespace Monitor{
    // Forward declerations
    namespace Utility{
        class    CallbackBase;
        class    Timer;
        class    Timeout;
    };
namespace BellMaster {


// Forward declerations within namespace
class    Bell;
class    Tapper;



class Signalman
{
public:

    Signalman(const string&     newName = string(""),
              const unsigned    newBeatInterval = 186,
              const unsigned    newSetInterval = 750);

    virtual ~Signalman();


    Signalman&
    operator=(const Signalman&    other);

    int
    operator==(const Signalman&    other) const;

    int
    operator<(const Signalman&    other) const;


    void
    beatSequence(Tapper&    tapper, const string&    sequence) const;

    const string&
    getName() const { return name; }
    
    unsigned
    getBeatInterval() const;

    void
    setBeatInterval(const unsigned    newInterval);

    unsigned
    getSetInterval() const;

    void
    setSetInterval(const unsigned    newInterval);

    int
    isBusy();

    void
    listenToBell(Bell&                                    newBell,
                 const Monitor::Utility::CallbackBase&    timeoutCallback);

    const string
    stopListeningToBell();

private:
    void
    hearBell();

    string    name;

    unsigned    beatInterval;

    unsigned    setInterval;

    Monitor::Utility::Timer*    ringTimer;

    Monitor::Utility::Timeout*    ringTimeout;

    unsigned    heardIntervals[65];
};  // class Signalman

};  // namespace BellMaster
};  // namespace Monitor


#endif // __SGNLMAN_H_INCLUDED__

---