<CENTER>
<a class="qindex" href="index.html">Home</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.4.4 -->
-<h1>RtError Class Reference</h1><!-- doxytag: class="RtError" -->Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> & RtMidi.
+<!-- Generated by Doxygen 1.5.8 -->
+<div class="contents">
+<h1>RtError Class Reference</h1><!-- doxytag: class="RtError" -->Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> & RtMidi.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="RtError_8h-source.html">RtError.h</a>></code>
+<p>
+
<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 class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#w11">Type</a> { <br>
- <a class="el" href="classRtError.html#w11w0">WARNING</a>,
-<a class="el" href="classRtError.html#w11w1">DEBUG_WARNING</a>,
-<a class="el" href="classRtError.html#w11w2">UNSPECIFIED</a>,
-<a class="el" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a>,
+<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">Type</a> { <br>
+ <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a>,
+<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a>,
+<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a>,
+<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a>,
<br>
- <a class="el" href="classRtError.html#w11w4">INVALID_DEVICE</a>,
-<a class="el" href="classRtError.html#w11w5">MEMORY_ERROR</a>,
-<a class="el" href="classRtError.html#w11w6">INVALID_PARAMETER</a>,
-<a class="el" href="classRtError.html#w11w7">INVALID_USE</a>,
+ <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a>,
+<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a>,
+<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a>,
+<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac8e65f51a3fbdc1a4a1552b3260df36bc">INVALID_USE</a>,
<br>
- <a class="el" href="classRtError.html#w11w8">DRIVER_ERROR</a>,
-<a class="el" href="classRtError.html#w11w9">SYSTEM_ERROR</a>,
-<a class="el" href="classRtError.html#w11w10">THREAD_ERROR</a>
+ <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a>,
+<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a>,
+<a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a>
<br>
}</td></tr>
-<tr><td class="mdescLeft"> </td><td class="mdescRight">Defined RtError types. <a href="classRtError.html#w11">More...</a><br></td></tr>
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> types. <a href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="RtError::RtError" ref="a0" args="(const std::string &message, Type type=RtError::UNSPECIFIED)" -->
- </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#w11">Type</a> type=RtError::UNSPECIFIED) throw ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a479a305ccbe56be0fd9137b9b405a37"></a><!-- doxytag: member="RtError::RtError" ref="a479a305ccbe56be0fd9137b9b405a37" args="(const std::string &message, Type type=RtError::UNSPECIFIED)" -->
+ </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a479a305ccbe56be0fd9137b9b405a37">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">Type</a> type=RtError::UNSPECIFIED) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="RtError::~RtError" ref="a1" args="(void)" -->
-virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a1">~RtError</a> (void) throw ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6793e03386e7e69ffafb65a296dfa48c"></a><!-- doxytag: member="RtError::~RtError" ref="6793e03386e7e69ffafb65a296dfa48c" args="(void)" -->
+virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#6793e03386e7e69ffafb65a296dfa48c">~RtError</a> (void) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="RtError::printMessage" ref="a2" args="(void)" -->
-virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a2">printMessage</a> (void) throw ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="da41f7472122f45bc5b4677f066e0943"></a><!-- doxytag: member="RtError::printMessage" ref="da41f7472122f45bc5b4677f066e0943" args="(void)" -->
+virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#da41f7472122f45bc5b4677f066e0943">printMessage</a> (void) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints thrown error message to stderr. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="RtError::getType" ref="a3" args="(void)" -->
-virtual const <a class="el" href="classRtError.html#w11">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3">getType</a> (void) throw ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ee7df9728d73f533afbaddcd9ca4d9c"></a><!-- doxytag: member="RtError::getType" ref="4ee7df9728d73f533afbaddcd9ca4d9c" args="(void)" -->
+virtual const <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#4ee7df9728d73f533afbaddcd9ca4d9c">getType</a> (void) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message type. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="RtError::getMessage" ref="a4" args="(void)" -->
-virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a4">getMessage</a> (void) throw ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c7f467788e29d246333d7af050801164"></a><!-- doxytag: member="RtError::getMessage" ref="c7f467788e29d246333d7af050801164" args="(void)" -->
+virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#c7f467788e29d246333d7af050801164">getMessage</a> (void) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message string. <br></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="RtError::what" ref="a5" args="(void) const " -->
-virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a5">what</a> (void) const throw ()</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eb843b7a7785d66061c61ebfc29e7e9d"></a><!-- doxytag: member="RtError::what" ref="eb843b7a7785d66061c61ebfc29e7e9d" args="(void) const " -->
+virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#eb843b7a7785d66061c61ebfc29e7e9d">what</a> (void) const throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message as a c-style string. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
-Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> & RtMidi.
-<p>
-The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w11">RtError::Type</a>. See the <a class="el" href="classRtAudio.html">RtAudio</a> and RtMidi documentation to know which methods can throw an RtError.
+Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> & RtMidi.
<p>
-<hr><h2>Member Enumeration Documentation</h2>
-<a class="anchor" name="w11"></a><!-- doxytag: member="RtError::Type" ref="w11" args="" --><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
+The <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac" title="Defined RtError types.">RtError::Type</a>. See the <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> and RtMidi documentation to know which methods can throw an <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a>. <hr><h2>Member Enumeration Documentation</h2>
+<a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac"></a><!-- doxytag: member="RtError::Type" ref="b04667aae01bffc354a9ac6bda6903ac" args="" -->
+<div class="memitem">
+<div class="memproto">
+ <table class="memname">
<tr>
- <td class="md" nowrap valign="top">enum <a class="el" href="classRtError.html#w11">RtError::Type</a> </td>
+ <td class="memname">enum <a class="el" href="classRtError.html#b04667aae01bffc354a9ac6bda6903ac">RtError::Type</a> </td>
</tr>
</table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
+</div>
+<div class="memdoc">
<p>
-Defined RtError types.
+Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio & RtMidi.">RtError</a> types.
<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
-<tr><td valign="top"><em><a class="anchor" name="w11w0"></a><!-- doxytag: member="WARNING" ref="w11w0" args="" -->WARNING</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398"></a><!-- doxytag: member="WARNING" ref="b04667aae01bffc354a9ac6bda6903ac3a1603c24a56cbdaf5f8ae4ddcb86398" args="" -->WARNING</em> </td><td>
A non-critical error. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w1"></a><!-- doxytag: member="DEBUG_WARNING" ref="w11w1" args="" -->DEBUG_WARNING</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba"></a><!-- doxytag: member="DEBUG_WARNING" ref="b04667aae01bffc354a9ac6bda6903ac20e5a369394d19b704ace17002007eba" args="" -->DEBUG_WARNING</em> </td><td>
A non-critical error which might be useful for debugging. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w2"></a><!-- doxytag: member="UNSPECIFIED" ref="w11w2" args="" -->UNSPECIFIED</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6"></a><!-- doxytag: member="UNSPECIFIED" ref="b04667aae01bffc354a9ac6bda6903ac444efd3ccf774b2ba9f9bde70ec71cd6" args="" -->UNSPECIFIED</em> </td><td>
The default, unspecified error type. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w3"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="w11w3" args="" -->NO_DEVICES_FOUND</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="b04667aae01bffc354a9ac6bda6903acf267eb2d710f33d649ba840eeab6ff82" args="" -->NO_DEVICES_FOUND</em> </td><td>
No devices found on system. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w4"></a><!-- doxytag: member="INVALID_DEVICE" ref="w11w4" args="" -->INVALID_DEVICE</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1"></a><!-- doxytag: member="INVALID_DEVICE" ref="b04667aae01bffc354a9ac6bda6903acd6064062066fffdba258237a7c2159b1" args="" -->INVALID_DEVICE</em> </td><td>
An invalid device ID was specified. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w5"></a><!-- doxytag: member="MEMORY_ERROR" ref="w11w5" args="" -->MEMORY_ERROR</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e"></a><!-- doxytag: member="MEMORY_ERROR" ref="b04667aae01bffc354a9ac6bda6903acb4f813e5a36905c89d4081a59497432e" args="" -->MEMORY_ERROR</em> </td><td>
An error occured during memory allocation. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w6"></a><!-- doxytag: member="INVALID_PARAMETER" ref="w11w6" args="" -->INVALID_PARAMETER</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6"></a><!-- doxytag: member="INVALID_PARAMETER" ref="b04667aae01bffc354a9ac6bda6903aca3eabf0f71120beaba94148a1b78fed6" args="" -->INVALID_PARAMETER</em> </td><td>
An invalid parameter was specified to a function. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w7"></a><!-- doxytag: member="INVALID_USE" ref="w11w7" args="" -->INVALID_USE</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac8e65f51a3fbdc1a4a1552b3260df36bc"></a><!-- doxytag: member="INVALID_USE" ref="b04667aae01bffc354a9ac6bda6903ac8e65f51a3fbdc1a4a1552b3260df36bc" args="" -->INVALID_USE</em> </td><td>
The function was called incorrectly. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w8"></a><!-- doxytag: member="DRIVER_ERROR" ref="w11w8" args="" -->DRIVER_ERROR</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b"></a><!-- doxytag: member="DRIVER_ERROR" ref="b04667aae01bffc354a9ac6bda6903ac995e97ecf6beeedaba525022a63aec6b" args="" -->DRIVER_ERROR</em> </td><td>
A system driver error occured. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w9"></a><!-- doxytag: member="SYSTEM_ERROR" ref="w11w9" args="" -->SYSTEM_ERROR</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b"></a><!-- doxytag: member="SYSTEM_ERROR" ref="b04667aae01bffc354a9ac6bda6903ac8947d0a2e2a84ecf3646271844e06a6b" args="" -->SYSTEM_ERROR</em> </td><td>
A system error occured. </td></tr>
-<tr><td valign="top"><em><a class="anchor" name="w11w10"></a><!-- doxytag: member="THREAD_ERROR" ref="w11w10" args="" -->THREAD_ERROR</em> </td><td>
+<tr><td valign="top"><em><a class="anchor" name="b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6"></a><!-- doxytag: member="THREAD_ERROR" ref="b04667aae01bffc354a9ac6bda6903aceb6282f991e2d93ab294a4272fc3f6c6" args="" -->THREAD_ERROR</em> </td><td>
A thread error occured. </td></tr>
</table>
</dl>
- </td>
- </tr>
-</table>
+
+</div>
+</div><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>
+</div>
<HR>
<table><tr><td><img src="../images/mcgill.gif" width=165></td>
- <td>©2001-200
8 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr>
+ <td>©2001-200
9 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr>
</table>
</BODY>
projects / rtaudio.git / blobdiff