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
|
<!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: CapiMsgError 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>CapiMsgError Class Reference</h1><a class="el" href="classCapi.html">Capi</a> Abstraction Layer exception class thrown if an error is indicated by <a class="el" href="classCapi.html">Capi</a>.
<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 CapiMsgError:
<p><center><img src="classCapiMsgError.png" usemap="#CapiMsgError_map" border="0" alt=""></center>
<map name="CapiMsgError_map">
<area href="classCapiError.html" alt="CapiError" shape="rect" coords="0,0,92,24">
</map>
<a href="classCapiMsgError-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="classCapiMsgError.html#a0">CapiMsgError</a> (unsigned <a class="el" href="classCapiMsgError.html#p0">info</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="classCapiMsgError.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>unsigned </td><td class="memItemRight" valign=bottom><a class="el" href="classCapiMsgError.html#p0">info</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">error code given by CAPI <a href="#p0"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classCapi.html">Capi</a> Abstraction Layer exception class thrown if an error is indicated by <a class="el" href="classCapi.html">Capi</a>.
<p>
This exception serves as a way to communicate errors indicated by CAPI to the application. These are mostly errors indicated from CAPI_PUT_MESSAGE or *_CONF messages.<p>
It includes also the error code given by CAPI in the info attribute.<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="CapiMsgError::CapiMsgError" ></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"> CapiMsgError::CapiMsgError </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">unsigned </td>
<td class="mdname" nowrap> <em>info</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td></td>
<td class="md" nowrap>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>info</em> </td><td>error code given by CAPI </td></tr>
<tr><td></td><td valign=top><em>errormsg</em> </td><td>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="CapiMsgError::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 CapiMsgError::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 from <a class="el" href="classCapiError.html#a1">CapiError</a>.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="p0" doxytag="CapiMsgError::info" ></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"> unsigned <a class="el" href="classCapiMsgError.html#p0">CapiMsgError::info</a><code> [protected]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
error code given by CAPI
<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>
|
