doc/html/classRtError.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>The RtAudio Home Page</TITLE>
   4 <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
   5 <LINK REL="SHORTCUT ICON" HREF="http://www.music.mcgill.ca/~gary/favicon.ico">
   6 </HEAD>
   7 <BODY BGCOLOR="#FFFFFF">
   8 <CENTER>
   9 <a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </CENTER>
  10 <HR>
  11 <!-- Generated by Doxygen 1.8.2 -->
  12 </div><!-- top -->
  13 <div class="header">
  14   <div class="summary">
  15 <a href="#pub-types">Public Types</a> &#124;
  16 <a href="#pub-methods">Public Member Functions</a> &#124;
  17 <a href="classRtError-members.html">List of all members</a>  </div>
  18   <div class="headertitle">
  19 <div class="title">RtError Class Reference</div>  </div>
  20 </div><!--header-->
  21 <div class="contents">
  22
  23 <p>Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> &amp; RtMidi.
  24  <a href="classRtError.html#details">More...</a></p>
  25
  26 <p><code>#include &lt;<a class="el" href="RtError_8h_source.html">RtError.h</a>&gt;</code></p>
  27
  28 <p>Inherits exception.</p>
  29 <table class="memberdecls">
  30 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  31 Public Types</h2></td></tr>
  32 <tr class="memitem:ab04667aae01bffc354a9ac6bda6903ac"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> { <br/>
  33 &#160;&#160;<a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398">WARNING</a>,
  34 <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba">DEBUG_WARNING</a>,
  35 <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">UNSPECIFIED</a>,
  36 <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82">NO_DEVICES_FOUND</a>,
  37 <br/>
  38 &#160;&#160;<a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1">INVALID_DEVICE</a>,
  39 <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e">MEMORY_ERROR</a>,
  40 <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6">INVALID_PARAMETER</a>,
  41 <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc">INVALID_USE</a>,
  42 <br/>
  43 &#160;&#160;<a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b">DRIVER_ERROR</a>,
  44 <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b">SYSTEM_ERROR</a>,
  45 <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6">THREAD_ERROR</a>
  46 <br/>
  47  }</td></tr>
  48 <tr class="memdesc:ab04667aae01bffc354a9ac6bda6903ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> types.  <a href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">More...</a><br/></td></tr>
  49 <tr class="separator:ab04667aae01bffc354a9ac6bda6903ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50 </table><table class="memberdecls">
  51 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  52 Public Member Functions</h2></td></tr>
  53 <tr class="memitem:aa479a305ccbe56be0fd9137b9b405a37"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa479a305ccbe56be0fd9137b9b405a37"></a>
  54 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#aa479a305ccbe56be0fd9137b9b405a37">RtError</a> (const std::string &amp;message, <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> type=<a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6">RtError::UNSPECIFIED</a>)  throw ()</td></tr>
  55 <tr class="memdesc:aa479a305ccbe56be0fd9137b9b405a37"><td class="mdescLeft">&#160;</td><td class="mdescRight">The constructor. <br/></td></tr>
  56 <tr class="separator:aa479a305ccbe56be0fd9137b9b405a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57 <tr class="memitem:a6793e03386e7e69ffafb65a296dfa48c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6793e03386e7e69ffafb65a296dfa48c"></a>
  58 virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a6793e03386e7e69ffafb65a296dfa48c">~RtError</a> (void)  throw ()</td></tr>
  59 <tr class="memdesc:a6793e03386e7e69ffafb65a296dfa48c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The destructor. <br/></td></tr>
  60 <tr class="separator:a6793e03386e7e69ffafb65a296dfa48c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:a251dcdac396c998c91706dd2dd3b8bfc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a251dcdac396c998c91706dd2dd3b8bfc"></a>
  62 virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a251dcdac396c998c91706dd2dd3b8bfc">printMessage</a> (void) const   throw ()</td></tr>
  63 <tr class="memdesc:a251dcdac396c998c91706dd2dd3b8bfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints thrown error message to stderr. <br/></td></tr>
  64 <tr class="separator:a251dcdac396c998c91706dd2dd3b8bfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 <tr class="memitem:a3e316dc9b9b41fe2f64cabf34beb4fe7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e316dc9b9b41fe2f64cabf34beb4fe7"></a>
  66 virtual const <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">Type</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3e316dc9b9b41fe2f64cabf34beb4fe7">getType</a> (void) const   throw ()</td></tr>
  67 <tr class="memdesc:a3e316dc9b9b41fe2f64cabf34beb4fe7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the thrown error message type. <br/></td></tr>
  68 <tr class="separator:a3e316dc9b9b41fe2f64cabf34beb4fe7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  69 <tr class="memitem:afd067ba6b46edd37f989cad02cd70b50"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afd067ba6b46edd37f989cad02cd70b50"></a>
  70 virtual const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#afd067ba6b46edd37f989cad02cd70b50">getMessage</a> (void) const   throw ()</td></tr>
  71 <tr class="memdesc:afd067ba6b46edd37f989cad02cd70b50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the thrown error message string. <br/></td></tr>
  72 <tr class="separator:afd067ba6b46edd37f989cad02cd70b50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 <tr class="memitem:aeb843b7a7785d66061c61ebfc29e7e9d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeb843b7a7785d66061c61ebfc29e7e9d"></a>
  74 virtual const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#aeb843b7a7785d66061c61ebfc29e7e9d">what</a> (void) const   throw ()</td></tr>
  75 <tr class="memdesc:aeb843b7a7785d66061c61ebfc29e7e9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the thrown error message as a c-style string. <br/></td></tr>
  76 <tr class="separator:aeb843b7a7785d66061c61ebfc29e7e9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77 </table>
  78 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  79 <div class="textblock"><p>Exception handling class for <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> &amp; RtMidi. </p>
  80 <p>The <a class="el" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac" 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 &amp; RtMidi.">RtError</a>. </p>
  81 </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  82 <a class="anchor" id="ab04667aae01bffc354a9ac6bda6903ac"></a>
  83 <div class="memitem">
  84 <div class="memproto">
  85       <table class="memname">
  86         <tr>
  87           <td class="memname">enum <a class="el" href="classRtError.html#ab04667aae01bffc354a9ac6bda6903ac">RtError::Type</a></td>
  88         </tr>
  89       </table>
  90 </div><div class="memdoc">
  91
  92 <p>Defined <a class="el" href="classRtError.html" title="Exception handling class for RtAudio &amp; RtMidi.">RtError</a> types. </p>
  93 <dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
  94 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca3a1603c24a56cbdaf5f8ae4ddcb86398"></a>WARNING</em>&nbsp;</td><td>
  95 <p>A non-critical error. </p>
  96 </td></tr>
  97 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca20e5a369394d19b704ace17002007eba"></a>DEBUG_WARNING</em>&nbsp;</td><td>
  98 <p>A non-critical error which might be useful for debugging. </p>
  99 </td></tr>
 100 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca444efd3ccf774b2ba9f9bde70ec71cd6"></a>UNSPECIFIED</em>&nbsp;</td><td>
 101 <p>The default, unspecified error type. </p>
 102 </td></tr>
 103 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaf267eb2d710f33d649ba840eeab6ff82"></a>NO_DEVICES_FOUND</em>&nbsp;</td><td>
 104 <p>No devices found on system. </p>
 105 </td></tr>
 106 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acad6064062066fffdba258237a7c2159b1"></a>INVALID_DEVICE</em>&nbsp;</td><td>
 107 <p>An invalid device ID was specified. </p>
 108 </td></tr>
 109 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acab4f813e5a36905c89d4081a59497432e"></a>MEMORY_ERROR</em>&nbsp;</td><td>
 110 <p>An error occured during memory allocation. </p>
 111 </td></tr>
 112 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaa3eabf0f71120beaba94148a1b78fed6"></a>INVALID_PARAMETER</em>&nbsp;</td><td>
 113 <p>An invalid parameter was specified to a function. </p>
 114 </td></tr>
 115 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca8e65f51a3fbdc1a4a1552b3260df36bc"></a>INVALID_USE</em>&nbsp;</td><td>
 116 <p>The function was called incorrectly. </p>
 117 </td></tr>
 118 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca995e97ecf6beeedaba525022a63aec6b"></a>DRIVER_ERROR</em>&nbsp;</td><td>
 119 <p>A system driver error occured. </p>
 120 </td></tr>
 121 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903aca8947d0a2e2a84ecf3646271844e06a6b"></a>SYSTEM_ERROR</em>&nbsp;</td><td>
 122 <p>A system error occured. </p>
 123 </td></tr>
 124 <tr><td valign="top"><em><a class="anchor" id="ab04667aae01bffc354a9ac6bda6903acaeb6282f991e2d93ab294a4272fc3f6c6"></a>THREAD_ERROR</em>&nbsp;</td><td>
 125 <p>A thread error occured. </p>
 126 </td></tr>
 127 </table>
 128 </dd>
 129 </dl>
 130
 131 </div>
 132 </div>
 133 <hr/>The documentation for this class was generated from the following file:<ul>
 134 <li><a class="el" href="RtError_8h_source.html">RtError.h</a></li>
 135 </ul>
 136 </div><!-- contents -->
 137 <HR>
 138 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
 139   <td>&copy;2001-2013 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>
 140 </table>
 141 </BODY>
 142 </HTML>