doc_exception.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: doc_exception.hpp,v $
 * PRODUCTION Revision 1000.0  2003/10/31 20:20:28  gouriano
 * PRODUCTION PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.7
 * PRODUCTION
 * ===========================================================================
 */

#ifndef GUI_CORE___DOC_EXCEPTION__HPP
#define GUI_CORE___DOC_EXCEPTION__HPP

/*  $Id: doc_exception.hpp,v 1000.0 2003/10/31 20:20:28 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:
 *    Exception class for the documents
 */


#include <corelib/ncbiexpt.hpp>

BEGIN_NCBI_SCOPE

//
// Class CDocException is a CException-derived class used for standard
// error reporting in the GBENCH framework.  This class defines exceptions
// related to document management and data loading.
//
class NCBI_GUICORE_EXPORT CDocException : EXCEPTION_VIRTUAL_BASE public CException
{
public:
    // Enumerated list of document management errors
    enum EErrCode {
        eFileNotFound,
        eInvalidFileType,
        eLoadFailed,
        eMemoryError,
        eObjectManagerError,
        eRecordNotFound,
        eVersionMismatch
    };

    // Translate the specific error code into a string representations of
    // that error code.
    virtual const char* GetErrCodeString(void) const
    {
        switch (GetErrCode()) {
        case eFileNotFound:         return "eFileNotFound";
        case eInvalidFileType:      return "eInvalidFileType";
        case eMemoryError:          return "eMemoryError";
        case eObjectManagerError:   return "eObjectManagerError";
        case eRecordNotFound:       return "eRecordNotFound";
        case eVersionMismatch:      return "eVersionMismatch";
        default:                    return CException::GetErrCodeString();
        }
    }

    NCBI_EXCEPTION_DEFAULT(CDocException, CException);
};

END_NCBI_SCOPE


#endif  // GUI_CORE___DOC_EXCEPTION__HPP


/*
 * ===========================================================================
 * $Log: doc_exception.hpp,v $
 * Revision 1000.0  2003/10/31 20:20:28  gouriano
 * PRODUCTION: IMPORTED [ORIGINAL] Dev-tree R1.7
 *
 * Revision 1.7  2003/09/29 15:20:06  dicuccio
 * Deprecated gui/scope.hpp.  Merged gui/core/types.hpp into gui/types.hpp
 *
 * Revision 1.6  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.5  2002/12/19 18:13:02  dicuccio
 * Added export specifiers for Win32.
 *
 * Revision 1.4  2002/12/09 13:34:03  dicuccio
 * Added documentation
 *
 * Revision 1.3  2002/11/29 15:51:35  dicuccio
 * Moved constructor macro to bottom of class per coding standard
 *
 * Revision 1.2  2002/11/07 18:20:12  dicuccio
 * Moved #ifdef to top of file.
 *
 * Revision 1.1  2002/11/04 21:09:05  dicuccio
 * Initial revision
 *
 * ===========================================================================
 */