---

sgarch.h

Go to the documentation of this file.

#ifndef __SGARCH_H_INCLUDED__
#define __SGARCH_H_INCLUDED__

// $Id$

//**********************************************************************
//                                                                     *
//    Description:   Abstract base class defining interface used to    *
//                   store and retrieve instances of Signalman to and  *
//                   from archive.                                     *
//                                                                     *
//    Author:        Chris White (whitecf@bcs.org.uk)                  *
//                                                                     *
//    Copyright (C) 2002  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:                                                           *
//                                                                     *
//**********************************************************************


// Forward declerations
class    string;


namespace Monitor {
namespace BellMaster {


// Forward declerations within namespace
class    Signalman;



class SignalmanArchive
{
public:
    SignalmanArchive();
    
    void
    store(const Signalman&    target);

    int
    retrieve(Signalman&    target);

protected:
    virtual void
    storeName(const string&    name) = 0;

    virtual void
    storeBeatInterval(const unsigned&    interval) = 0;

    virtual void
    storeSetInterval(const unsigned&    interval) = 0;

    virtual int
    retrieveName(string&    name) = 0;

    virtual int
    retrieveBeatInterval(unsigned&    interval) = 0;

    virtual int
    retrieveSetInterval(unsigned&    interval) = 0;
};  // class SignalmanArchive

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


#endif // __SGARCH_H_INCLUDED__

---