blob: 395a94908c7b50d20478cae2df50db5e3aa8d8b5 (
plain)
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
|
<HTML>
<HEAD>
<TITLE>The RtMidi Tutorial</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER>
<HR>
<!-- Generated by Doxygen 1.3-rc3 -->
<h1>RtError Class Reference</h1>Exception handling class for RtAudio & <a class="el" href="classRtMidi.html">RtMidi</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="RtError_8h-source.html">RtError.h</a>></code>
<p>
<a href="classRtError-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 Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="classRtError.html#s11">Type</a> </td></tr>
<tr><td> </td><td><font size=-1><em>Defined RtError types.</em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td nowrap align=right valign=top><a name="a0" doxytag="RtError::RtError"></a>
</td><td valign=bottom><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#s11">Type</a> type=RtError::UNSPECIFIED)</td></tr>
<tr><td> </td><td><font size=-1><em>The constructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a1" doxytag="RtError::~RtError"></a>
virtual </td><td valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>The destructor.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a2" doxytag="RtError::printMessage"></a>
virtual void </td><td valign=bottom><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Prints "thrown" error message to stdout.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a3" doxytag="RtError::getType"></a>
virtual const <a class="el" href="classRtError.html#s11">Type</a> & </td><td valign=bottom><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the "thrown" error message type.</em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a name="a4" doxytag="RtError::getMessage"></a>
virtual const std::string & </td><td valign=bottom><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the "thrown" error message string.</em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Exception handling class for RtAudio & <a class="el" href="classRtMidi.html">RtMidi</a>.
<p>
The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#s11">RtError::Type</a>. See the RtAudio and <a class="el" href="classRtMidi.html">RtMidi</a> documentation to know which methods can "throw" an RtError.
<p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="RtError_8h-source.html">RtError.h</a></ul>
<HR>
<table><tr><td><img src="../images/mcgill.gif" width=165></td>
<td>©2003-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br>
Maintained by Gary P. Scavone, gary at music.mcgill.ca</td></tr>
</table>
</BODY>
</HTML>
|
