plugin_exception.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: plugin_exception.hpp,v $
 * PRODUCTION Revision 1000.0  2003/10/31 20:22:14  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.5
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_CORE___PLUGIN_EXCEPTION__HPP
#define GUI_CORE___PLUGIN_EXCEPTION__HPP

/*  $Id: plugin_exception.hpp,v 1000.0 2003/10/31 20:22:14 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:
 *    CPluginException -- defines exceptions produced by plugins
 */

#include <corelib/ncbiexpt.hpp>

BEGIN_NCBI_SCOPE


class CPluginException : EXCEPTION_VIRTUAL_BASE public CException
{
public:
    // Enumerated list of document management errors
    enum EErrCode {
        eNotSupported,
        eDefaultArgNotSupported,
        eInvalidArg,
        eInvalidCommand,
        eInvalidHandle,
        eInvalidMessage,
        eMissingRequiredArg,
        ePluginLoadFailed,
        eVersionMismatch,
        eUnknownError
    };

    // Translate the specific error code into a string representations of
    // that error code.
    virtual const char* GetErrCodeString(void) const
    {
        switch (GetErrCode()) {
        case eNotSupported:             return "eNotSupported";
        case eDefaultArgNotSupported:   return "eDefaultArgNotSupported";
        case eInvalidArg:               return "eInvalidArg";
        case eInvalidCommand:           return "eInvalidCommand";
        case eInvalidHandle:            return "eInvalidHandle";
        case eInvalidMessage:           return "eInvalidMessage";
        case eMissingRequiredArg:       return "eMissingRequiredArg";
        case ePluginLoadFailed:         return "ePluginLoadFailed";
        case eVersionMismatch:          return "eVersionMismatch";
        case eUnknownError:             return "eUnknownError";
        default:                        return CException::GetErrCodeString();
        }
    }

    NCBI_EXCEPTION_DEFAULT(CPluginException, CException);
};


END_NCBI_SCOPE


#endif  // GUI_CORE___PLUGIN_EXCEPTION__HPP

/*
 * ===========================================================================
 * $Log: plugin_exception.hpp,v $
 * Revision 1000.0  2003/10/31 20:22:14  gouriano
 * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.5
 *
 * Revision 1.5  2003/07/14 10:57:41  shomrat
 * Plugin messageing system related changes
 *
 * Revision 1.4  2003/06/30 13:42:47  dicuccio
 * Added generic error specification
 *
 * Revision 1.3  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.2  2003/02/21 16:42:57  dicuccio
 * Added error code for version mismatch
 *
 * Revision 1.1  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.
 *
 * ===========================================================================
 */