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

Go to the SVN repository for this file.

1 #ifndef OBJTOOLS_WRITERS__WRITER_EXCEPTION_HPP
2 #define OBJTOOLS_WRITERS__WRITER_EXCEPTION_HPP
3 
4 /* $Id: writer_exception.hpp 93574 2021-04-30 16:19:19Z stakhovv $
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: Josh Cherry
30  *
31  * File Description: Exception classes for objtools/writers
32  *
33  */
34 
35 
36 #include <corelib/ncbiexpt.hpp>
37 
39 
41 public:
42  enum EErrCode {
43  /// Argument validation failed
48  };
49 
50  virtual const char* GetErrCodeString() const override
51  {
52  switch (GetErrCode()) {
53  case eArgErr:
54  return "eArgErr";
55  case eBadInput:
56  return "eBadInput";
57  case eInterrupted:
58  return "eInterrpted";
59  case eInternal:
60  return "eInternal";
61  default:
63  }
64  }
65 
66  /// Include standard NCBI exception behavior.
68 };
69 
71 
72 #endif // OBJTOOLS_WRITERS__WRITER_EXCEPTION_HPP
73 
virtual const char * GetErrCodeString() const override
Get error code interpreted as text.
NCBI_EXCEPTION_DEFAULT(CObjWriterException, CException)
Include standard NCBI exception behavior.
@ eArgErr
Argument validation failed.
TErrCode GetErrCode(void) const
Get error code.
Definition: ncbiexpt.cpp:453
EErrCode
Error types that an application can generate.
Definition: ncbiexpt.hpp:884
virtual const char * GetErrCodeString(void) const
Get error code interpreted as text.
Definition: ncbiexpt.cpp:444
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_XOBJWRITE_EXPORT
Definition: ncbi_export.h:1347
Defines NCBI C++ exception handling.
Modified on Sat Dec 09 04:48:13 2023 by modify_doxy.py rev. 669887