-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdip-Error.html
186 lines (185 loc) · 11.3 KB
/
dip-Error.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>dip::Error class | DIPlib | a library for quantitative image analysis</title>
<link rel="stylesheet" href="m-dip+documentation.compiled.css" />
<link rel="icon" href="DIPlib_logo_32.png" type="image/png" />
<link rel="search" type="application/opensearchdescription+xml" href="opensearch.xml" title="Search DIPlib documentation" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#ffffff" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
<a href="https://diplib.org"><img src="DIPlib_logo.svg" alt="" />DIPlib</a><span class="m-breadcrumb">┃</span><a href="index.html" class="m-thin">a library for quantitative image analysis</a><span class="m-breadcrumb">┃</span><a href="https://github.com/DIPlib/diplib/releases/tag/3.5.2" class="m-thin">version 3.5.2</a> </span>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
</svg></a>
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li><a href="pages.html">Pages</a></li>
<li><a href="modules.html">Modules</a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="3">
<li><a href="classes.html">Classes</a></li>
<li><a href="files.html">Files</a></li>
<li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
<use href="#m-doc-search-icon-path" />
</svg></a></li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
<div class="m-doc-include m-thin m-right-m m-text-right">
<a href="error.html" class="m-doc">Error management</a> module<br/><span class="m-code m-thin">#include <a href="file--diplib-h.html">"diplib.h"</a></span> </div>
<span class="m-breadcrumb"><a href="dip.html">dip</a>::<wbr/></span>Error <span class="m-thin">class</span> </h1>
<p>Base exception class. All exceptions thrown in <em>DIPlib</em> are derived of this class.</p>
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#base-classes">Base classes</a></li>
<li><a href="#derived-classes">Derived classes</a></li>
<li><a href="#function-members">Functions</a></li>
</ul>
</li>
</ul>
</div>
<p>You can catch this exception at the top level, where you can communicate the problem to the user,
and only if you want to prevent your program from exiting abnormally.
This class is derived from <code>std::exception</code>, so you can choose to catch that instead.</p>
<section id="base-classes">
<h2>Base classes</h2>
<dl class="m-doc">
<dt>
class std::exception
</dt>
<dd></dd>
</dl>
</section>
<section id="derived-classes">
<h2>Derived classes</h2>
<dl class="m-doc">
<dt>
class <a href="dip-AssertionError.html" class="m-doc">dip::<wbr />AssertionError</a>
</dt>
<dd>Exception class indicating that an internal inconsistency was found (the library code is wrong).</dd>
<dt>
class <a href="dip-ParameterError.html" class="m-doc">dip::<wbr />ParameterError</a>
</dt>
<dd>Exception class indicating that a function received an inconsistent or out of range parameter
(the calling code is wrong).</dd>
<dt>
class <a href="dip-RunTimeError.html" class="m-doc">dip::<wbr />RunTimeError</a>
</dt>
<dd>Exception class indicating that something happened that we couldn’t predict (e.g. file error).</dd>
</dl>
</section>
<section id="function-members">
<h2>Functions</h2>
<dl class="m-doc">
<dt>
<span class="m-doc-wrap-bumper">auto <a href="#dip-Error-what-C" class="m-doc">what</a>(</span><span class="m-doc-wrap">) const -> char const* <span class="m-label m-flat m-warning">override</span> <span class="m-label m-flat m-success">noexcept</span></span>
</dt>
<dd>Return a message indicating what caused the exception to be thrown, as well as the location
where the error occurred. <a href="#dip-Error-what-C">more...</a></dd>
<dt id="dip-Error-Message-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Error-Message-C" class="m-doc-self">Message</a>(</span><span class="m-doc-wrap">) const -> std::string</span>
</dt>
<dd>Return a message indicating what caused the exception to be thrown, without location information.</dd>
<dt id="dip-Error-AddStackTrace-std-string-CL-std-string-CL-unsigned int-">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Error-AddStackTrace-std-string-CL-std-string-CL-unsigned int-" class="m-doc-self">AddStackTrace</a>(</span><span class="m-doc-wrap">std::string const& functionName,
std::string const& fileName,
unsigned int lineNumber) -> <a href="dip-Error.html" class="m-doc">dip::Error</a>&</span>
</dt>
<dd>Add an entry to the stack trace. Typically called through the <a href="error.html#macro--DIP_ADD_STACK_TRACE"><code>DIP_ADD_STACK_TRACE</code></a> macro.</dd>
<dt id="dip-Error-IsSet-C">
<span class="m-doc-wrap-bumper">auto <a href="#dip-Error-IsSet-C" class="m-doc-self">IsSet</a>(</span><span class="m-doc-wrap">) const -> bool</span>
</dt>
<dd>Returns true if an error message is set. Use this to distinguish from a default-constructed error.</dd>
</dl>
</section>
<section>
<h2>Function documentation</h2>
<section class="m-doc-details" id="dip-Error-what-C"><div>
<h3>
<span class="m-doc-wrap-bumper">char const*
</span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#dip-Error-what-C" class="m-doc-self">what</a>(</span><span class="m-doc-wrap">) const <span class="m-label m-warning">override</span> <span class="m-label m-flat m-success">noexcept</span></span></span>
</h3>
<p>Return a message indicating what caused the exception to be thrown, as well as the location
where the error occurred.</p>
<p>Sometimes multiple locations are given, this is an (incomplete) stack trace that might help figure
out the error. Such a stack trace is generally created when it is a helper function that threw the
exception. Some calling functions will catch such an exception, add its name to the stack trace,
and re-throw the exception.</p>
<aside class="m-note m-default">
<h4>See also</h4>
<p><a href="error.html#macro--DIP_ADD_STACK_TRACE"><code>DIP_ADD_STACK_TRACE</code></a>, <a href="error.html#macro--DIP_START_STACK_TRACE"><code>DIP_START_STACK_TRACE</code></a>, <a href="error.html#macro--DIP_END_STACK_TRACE"><code>DIP_END_STACK_TRACE</code></a>, <a href="error.html#macro--DIP_STACK_TRACE_THIS"><code>DIP_STACK_TRACE_THIS</code></a></p>
</aside>
</div></section>
</section>
</div>
</div>
</div>
</article></main>
<div class="m-doc-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-doc-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">…</div>
</div>
<div class="m-doc-search-content">
<form action="https://diplib.org/diplib-docs/#search">
<input type="search" name="q" id="search-input" placeholder="Loading …" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
</form>
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript. Enable it or <a href="https://google.com/search?q=site:diplib.org+">use an external search engine</a>.</noscript>
<div id="search-help" class="m-text m-dim m-text-center">
<p class="m-noindent">Search for symbols, directories, files, pages or modules.
You can omit any prefix from the symbol or file path; adding a <code>:</code> or
<code>/</code> suffix lists all members of given symbol or directory.</p>
<p class="m-noindent">Use <span class="m-label m-dim">↓</span> / <span class="m-label m-dim">↑</span> to navigate through the list,
<span class="m-label m-dim">Enter</span> to go.
<span class="m-label m-dim">Tab</span> autocompletes common prefix.
You can copy a link to the result using <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">L</span>,
or <span class="m-label m-dim">⌘</span> <span class="m-label m-dim">M</span> to copy a Markdown link.</p>
</div>
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.<br />Maybe try a full-text <a href="#" id="search-external" data-search-engine="https://google.com/search?q=site:diplib.org+{query}">search with external engine</a>?</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search-v1.js"></script>
<script src="searchdata-v1.js" async="async"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<p>DIPlib, a library for quantitative image analysis. Documentation compiled with <a href="https://crisluengo.github.io/doxpp/">dox++</a> and styled with <a href="https://mcss.mosra.cz/">m.css</a>.</p>
</div>
</div>
</div>
</nav></footer>
</body>
</html>