algo.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: algo.hpp,v $
 * PRODUCTION Revision 1000.2  2004/04/12 18:11:59  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.12
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_CORE___ALGO__HPP
#define GUI_CORE___ALGO__HPP

/*  $Id: algo.hpp,v 1000.2 2004/04/12 18:11:59 gouriano Exp $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Authors:  Mike DiCuccio
 *
 * File Description:
 *    CAlgorithm -- base class for GBENCH algorithms
 */

#include <corelib/ncbiobj.hpp>
#include <gui/core/plugin.hpp>
#include <gui/plugin/PluginCommand.hpp>
#include <gui/plugin/PluginReply.hpp>


BEGIN_NCBI_SCOPE


//
// Base class to wrap algorithm functionality
//

template <typename PluginType>
class CAlgorithm : public CPlugin<PluginType>
{
public:
    CAlgorithm(void) {}
    virtual ~CAlgorithm(void) {}
    virtual void RunCommand(objects::CPluginMessage& msg) = 0;

private:
    // Prohibit copying!
    CAlgorithm(const CAlgorithm&);
    CAlgorithm& operator= (const CAlgorithm&);
};


END_NCBI_SCOPE


/*
 * ===========================================================================
 * $Log: algo.hpp,v $
 * Revision 1000.2  2004/04/12 18:11:59  gouriano
 * PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.12
 *
 * Revision 1.12  2004/04/07 12:32:15  dicuccio
 * Include guard moved
 *
 * Revision 1.11  2003/11/04 17:09:04  dicuccio
 * Changed API to take a CPluginMessage instead of a paired command/reply
 *
 * Revision 1.10  2003/08/22 15:52:26  dicuccio
 * Removed unneeded export specifier.  Removed 'USING_SCOPE(objects)'
 *
 * Revision 1.9  2003/07/14 10:54:07  shomrat
 * Introduced CPlugin as base class for CAlgorithm
 *
 * Revision 1.8  2003/06/25 16:59:41  dicuccio
 * Changed CPluginHandle into a pointer-to-implementation (the previous
 * implementation is now the pointer held).  Lots of #include file clean-ups.
 *
 * Revision 1.7  2003/05/19 13:32:43  dicuccio
 * Moved gui/core/plugin --> gui/plugin/
 *
 * Revision 1.6  2003/02/24 13:00:17  dicuccio
 * Renamed classes in plugin spec:
 *     CArgSeg --> CPluginArgSet
 *     CArgument --> CPluginArg
 *     CPluginArgs --> CPluginCommand
 *     CPluginCommands --> CPluginCommandSet
 *
 * Revision 1.5  2003/02/20 19:44:06  dicuccio
 * Created new plugin architecture, mediated via an ASN.1 spec.  Moved GBENCH
 * framework over to use new plugin architecture.
 *
 * Revision 1.4  2003/01/13 13:11:41  dicuccio
 * Namespace clean-up.  Retired namespace gui -> converted to namespace ncbi.
 * Moved all FLUID-generated code into namespace ncbi.
 *
 * Revision 1.3  2002/12/19 18:13:02  dicuccio
 * Added export specifiers for Win32.
 *
 * Revision 1.2  2002/11/07 18:20:12  dicuccio
 * Moved #ifdef to top of file.
 *
 * Revision 1.1  2002/11/04 21:09:04  dicuccio
 * Initial revision
 *
 * ===========================================================================
 */


#endif  // GUI_CORE___ALGO__HPP