A library for working with phylogenetic and population genetic data.
v0.32.0
exception.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_CORE_EXCEPTION_H_
2 #define GENESIS_UTILS_CORE_EXCEPTION_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2023 Lucas Czech
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lczech@carnegiescience.edu>
23  Department of Plant Biology, Carnegie Institution For Science
24  260 Panama Street, Stanford, CA 94305, USA
25 */
26 
34 #include <stdexcept>
35 #include <string>
36 
37 namespace genesis {
38 namespace utils {
39 
40 // =================================================================================================
41 // Exception Base Class
42 // =================================================================================================
43 
53 class Exception
54  : public std::exception
55 {
56 public:
57 
58  Exception( std::string const& message )
59  : message_( message )
60  {}
61 
62  char const* what() const noexcept override {
63  return message_.c_str();
64  }
65 
66 protected:
67 
68  std::string message_;
69 
70 };
71 
72 // =================================================================================================
73 // File Related Errors
74 // =================================================================================================
75 
79 class IOError
80  : public Exception
81 {
82 public:
83 
84  IOError( std::string const& message )
85  : Exception( message )
86  {}
87 
88  IOError( std::string const& message, std::string const& filename )
89  : Exception( message )
90  , filename_( filename )
91  {}
92 
93  std::string const& filename() const
94  {
95  return filename_;
96  }
97 
98 protected:
99 
100  std::string filename_;
101 };
102 
110  : public IOError
111 {
112 public:
113 
114  ExistingFileError( std::string const& message, std::string const& filename )
115  : IOError( message, filename )
116  {}
117 };
118 
119 } // namespace utils
120 } // namespace genesis
121 
122 #endif // include guard
genesis::utils::ExistingFileError
Exception class that is thrown if trying to write to an existing file.
Definition: exception.hpp:109
genesis::utils::IOError::filename
std::string const & filename() const
Definition: exception.hpp:93
genesis::utils::Exception::message_
std::string message_
Definition: exception.hpp:68
genesis::utils::Exception
Base class for genesis exceptions.
Definition: exception.hpp:53
genesis::utils::Exception::what
char const * what() const noexcept override
Definition: exception.hpp:62
genesis::utils::IOError::IOError
IOError(std::string const &message, std::string const &filename)
Definition: exception.hpp:88
genesis::utils::ExistingFileError::ExistingFileError
ExistingFileError(std::string const &message, std::string const &filename)
Definition: exception.hpp:114
genesis::utils::IOError
Exception class for general input/output errors.
Definition: exception.hpp:79
genesis
Container namespace for all symbols of genesis in order to keep them separate when used as a library.
Definition: placement/formats/edge_color.cpp:42
genesis::utils::IOError::filename_
std::string filename_
Definition: exception.hpp:100
genesis::utils::Exception::Exception
Exception(std::string const &message)
Definition: exception.hpp:58
genesis::utils::IOError::IOError
IOError(std::string const &message)
Definition: exception.hpp:84