Zivid C++ API  1.8.1+6967bc1b-1
Defining the Future of 3D Machine Vision
Exception.h
Go to the documentation of this file.
1 
2 /*******************************************************************************
3  * This file is part of the Zivid 3D Camera API
4  *
5  * Copyright 2015-2020 (C) Zivid AS
6  * All rights reserved.
7  *
8  * Zivid Software License, v1.0
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  *
13  * 1. Redistributions of source code must retain the above copyright notice,
14  * this list of conditions and the following disclaimer.
15  *
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * 3. Neither the name of Zivid AS nor the names of its contributors may be used
21  * to endorse or promote products derived from this software without specific
22  * prior written permission.
23  *
24  * 4. This software, with or without modification, must not be used with any
25  * other 3D camera than from Zivid AS.
26  *
27  * 5. Any software provided in binary form under this license must not be
28  * reverse engineered, decompiled, modified and/or disassembled.
29  *
30  * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
31  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
32  * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
33  * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
34  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
35  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
36  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
37  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
39  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Contact: Zivid Support <support@zivid.com>
42  * Info: http://www.zivid.com
43  ******************************************************************************/
44 
45 #pragma once
46 
47 #include "Zivid/APIExport.h"
48 
49 #include <exception>
50 #include <string>
51 
52 namespace Zivid
53 {
55  class ZIVID_API_EXPORT_NON_WIN32 Exception : public std::exception
56  {
57  protected:
59  ZIVID_API_EXPORT explicit Exception(const std::string &message);
60 
61  public:
63  ZIVID_API_EXPORT const char *what() const noexcept override;
64 
65  private:
66  std::string m_message;
67  };
68 
70  class ArgumentException : public Exception
71  {
72  protected:
74  ZIVID_API_EXPORT explicit ArgumentException(const std::string &message);
75  };
76 
78  class IOException : public Exception
79  {
80  public:
82  ZIVID_API_EXPORT explicit IOException(const std::string &message);
83  };
84 
86  class LogicException : public Exception
87  {
88  public:
90  ZIVID_API_EXPORT explicit LogicException(const std::string &message);
91  };
92 
94  class RuntimeException : public Exception
95  {
96  public:
98  ZIVID_API_EXPORT explicit RuntimeException(const std::string &message);
99  };
100 
103  ZIVID_API_EXPORT std::string toString(const std::exception &exception);
104 } // namespace Zivid
105 
106 #ifdef __has_include
107 # if __has_include("Zivid/InternalExceptions.h")
108 # ifndef _M_CEE
109 # include "Zivid/InternalExceptions.h"
110 # endif
111 # endif
112 #endif
Zivid::toString
ZIVID_API_EXPORT std::string toString(const std::exception &exception)
Get string representation of the exception
ZIVID_API_EXPORT_NON_WIN32
#define ZIVID_API_EXPORT_NON_WIN32
Definition: APIExport.h:61
APIExport.h
Zivid::RuntimeException
An exception that is thrown when an unpredictable event caused an operation to fail.
Definition: Exception.h:133
Zivid
The main Zivid namespace. All Zivid code is found here
Definition: Application.h:52
Zivid::Exception
A common base class for all Zivid exceptions.
Definition: Exception.h:94
ZIVID_API_EXPORT
#define ZIVID_API_EXPORT
Definition: APIExport.h:56