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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>CapiSuite: CapiError Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.8 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a></div>
<h1>CapiError Class Reference</h1>General and base class for errors in the <a class="el" href="classCapi.html">Capi</a> abstraction layer.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="capiexception_8h-source.html">capiexception.h</a>></code>
<p>
<p>Inheritance diagram for CapiError:
<p><center><img src="classCapiError.png" usemap="#CapiError_map" border="0" alt=""></center>
<map name="CapiError_map">
<area href="classCapiExternalError.html" alt="CapiExternalError" shape="rect" coords="0,56,114,80">
<area href="classCapiMsgError.html" alt="CapiMsgError" shape="rect" coords="124,56,238,80">
<area href="classCapiWrongState.html" alt="CapiWrongState" shape="rect" coords="248,56,362,80">
</map>
<a href="classCapiError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classCapiError.html#a0">CapiError</a> (string <a class="el" href="classCapiError.html#p0">errormsg</a>, string <a class="el" href="classCapiError.html#p1">function_name</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. Create an object, print error message and abort if severity FATAL was chosen. <a href="#a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual string </td><td class="memItemRight" valign=bottom><a class="el" href="classCapiError.html#a1">message</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return nice formatted error message. <a href="#a1"></a><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classCapiError.html#p0">errormsg</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">textual error message <a href="#p0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>string </td><td class="memItemRight" valign=bottom><a class="el" href="classCapiError.html#p1">function_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">function/method where this error occured <a href="#p1"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
General and base class for errors in the <a class="el" href="classCapi.html">Capi</a> abstraction layer.
<p>
This is the general class for all <a class="el" href="classCapi.html">Capi</a> errors. It serves as base class for the more specific exceptions and also as one-size-fits-all throwable object if the other errors doesn't fit. ;-)<p>
Each exception gets a severity (Warning, Error or Fatal), a message and the name of the function where it occurred. If you need further data, please derive a sub-class or format it into the errormsg.<p>
<dl compact><dt><b>Author:</b></dt><dd>Gernot Hillier </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="a0" doxytag="CapiError::CapiError" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> CapiError::CapiError </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">string </td>
<td class="mdname" nowrap> <em>errormsg</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>string </td>
<td class="mdname" nowrap> <em>function_name</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructor. Create an object, print error message and abort if severity FATAL was chosen.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign=top><em>errormsg</em> </td><td>some informal message describing the error </td></tr>
<tr><td></td><td valign=top><em>function_name</em> </td><td>name of the function which throws this exception</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1" doxytag="CapiError::message" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual string CapiError::message </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return nice formatted error message.
<p>
Returns the string "Classname: error message occured in function()" <dl compact><dt><b>Returns:</b></dt><dd>error message</dd></dl>
<p>
Reimplemented in <a class="el" href="classCapiWrongState.html#a1">CapiWrongState</a>, <a class="el" href="classCapiMsgError.html#a1">CapiMsgError</a>, and <a class="el" href="classCapiExternalError.html#a1">CapiExternalError</a>.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p0" doxytag="CapiError::errormsg" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> string <a class="el" href="classCapiError.html#p0">CapiError::errormsg</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
textual error message
<p>
</td>
</tr>
</table>
<a class="anchor" name="p1" doxytag="CapiError::function_name" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> string <a class="el" href="classCapiError.html#p1">CapiError::function_name</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
function/method where this error occured
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="capiexception_8h-source.html">capiexception.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Sun Nov 28 14:37:44 2004 for CapiSuite by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>
|
