NCBI C++ ToolKit
plugin_exception.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef GUI_CORE___PLUGIN_EXCEPTION__HPP
2 #define GUI_CORE___PLUGIN_EXCEPTION__HPP
3 
4 /* $Id: plugin_exception.hpp 47374 2023-02-23 00:42:16Z evgeniev $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Authors: Mike DiCuccio
30  *
31  * File Description:
32  * CPluginException -- defines exceptions produced by plugins
33  */
34 
35 #include <corelib/ncbiexpt.hpp>
36 
38 
39 
41 {
42 public:
43  // Enumerated list of document management errors
44  enum EErrCode {
55  };
56 
57  // Translate the specific error code into a string representations of
58  // that error code.
59  virtual const char* GetErrCodeString(void) const override
60  {
61  switch (GetErrCode()) {
62  case eNotSupported: return "eNotSupported";
63  case eDefaultArgNotSupported: return "eDefaultArgNotSupported";
64  case eInvalidArg: return "eInvalidArg";
65  case eInvalidCommand: return "eInvalidCommand";
66  case eInvalidHandle: return "eInvalidHandle";
67  case eInvalidMessage: return "eInvalidMessage";
68  case eMissingRequiredArg: return "eMissingRequiredArg";
69  case ePluginLoadFailed: return "ePluginLoadFailed";
70  case eVersionMismatch: return "eVersionMismatch";
71  case eUnknownError: return "eUnknownError";
72  default: return CException::GetErrCodeString();
73  }
74  }
75 
77 };
78 
79 
81 
82 #endif // GUI_CORE___PLUGIN_EXCEPTION__HPP
NCBI_EXCEPTION_DEFAULT(CPluginException, CException)
virtual const char * GetErrCodeString(void) const override
virtual const char * GetErrCodeString(void) const
Get error code interpreted as text.
Definition: ncbiexpt.cpp:444
#define EXCEPTION_VIRTUAL_BASE
Do not use virtual base classes in exception declaration at all, because in this case derived class s...
Definition: ncbiexpt.hpp:1388
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
Defines NCBI C++ exception handling.
Modified on Tue May 28 05:54:20 2024 by modify_doxy.py rev. 669887