doc/html/classRtError.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>The RtAudio Tutorial</TITLE>
   4 <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
   5 </HEAD>
   6 <BODY BGCOLOR="#FFFFFF">
   7 <CENTER>
   8 <a class="qindex" href="index.html">Tutorial</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>
   9 <HR>
  10 <!-- Generated by Doxygen 1.4.4 -->
  11 <h1>RtError Class Reference</h1><!-- doxytag: class="RtError" -->Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> &amp; RtMidi.
  12 <a href="#_details">More...</a>
  13 <p>
  14 <code>#include &lt;<a class="el" href="RtError_8h-source.html">RtError.h</a>&gt;</code>
  15 <p>
  16 <a href="classRtError-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  17 <tr><td></td></tr>
  18 <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
  19 <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#w11">Type</a> { <br>
  20 &nbsp;&nbsp;<a class="el" href="classRtError.html#w11w0">WARNING</a>,
  21 <a class="el" href="classRtError.html#w11w1">DEBUG_WARNING</a>,
  22 <a class="el" href="classRtError.html#w11w2">UNSPECIFIED</a>,
  23 <a class="el" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a>,
  24 <br>
  25 &nbsp;&nbsp;<a class="el" href="classRtError.html#w11w4">INVALID_DEVICE</a>,
  26 <a class="el" href="classRtError.html#w11w5">INVALID_STREAM</a>,
  27 <a class="el" href="classRtError.html#w11w6">MEMORY_ERROR</a>,
  28 <a class="el" href="classRtError.html#w11w7">INVALID_PARAMETER</a>,
  29 <br>
  30 &nbsp;&nbsp;<a class="el" href="classRtError.html#w11w8">DRIVER_ERROR</a>,
  31 <a class="el" href="classRtError.html#w11w9">SYSTEM_ERROR</a>,
  32 <a class="el" href="classRtError.html#w11w10">THREAD_ERROR</a>
  33 <br>
  34  }</td></tr>
  35
  36 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defined RtError types.  <a href="classRtError.html#w11">More...</a><br></td></tr>
  37 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
  38 <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 &amp;message, Type type=RtError::UNSPECIFIED)" -->
  39 &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &amp;message, <a class="el" href="classRtError.html#w11">Type</a> type=RtError::UNSPECIFIED)</td></tr>
  40
  41 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor. <br></td></tr>
  42 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="RtError::~RtError" ref="a1" args="(void)" -->
  43 virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr>
  44
  45 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor. <br></td></tr>
  46 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="RtError::printMessage" ref="a2" args="(void)" -->
  47 virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr>
  48
  49 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prints thrown error message to stderr. <br></td></tr>
  50 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="RtError::getType" ref="a3" args="(void)" -->
  51 virtual const <a class="el" href="classRtError.html#w11">Type</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr>
  52
  53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message type. <br></td></tr>
  54 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="RtError::getMessage" ref="a4" args="(void)" -->
  55 virtual const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr>
  56
  57 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message string. <br></td></tr>
  58 <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="RtError::getMessageString" ref="a5" args="(void)" -->
  59 virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a5">getMessageString</a> (void)</td></tr>
  60
  61 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message as a C string. <br></td></tr>
  62 </table>
  63 <hr><a name="_details"></a><h2>Detailed Description</h2>
  64 Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> &amp; RtMidi.
  65 <p>
  66 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.
  67 <p>
  68 <hr><h2>Member Enumeration Documentation</h2>
  69 <a class="anchor" name="w11"></a><!-- doxytag: member="RtError::Type" ref="w11" args="" --><p>
  70 <table class="mdTable" cellpadding="2" cellspacing="0">
  71   <tr>
  72     <td class="mdRow">
  73       <table cellpadding="0" cellspacing="0" border="0">
  74         <tr>
  75           <td class="md" nowrap valign="top">enum <a class="el" href="classRtError.html#w11">RtError::Type</a>          </td>
  76         </tr>
  77       </table>
  78     </td>
  79   </tr>
  80 </table>
  81 <table cellspacing="5" cellpadding="0" border="0">
  82   <tr>
  83     <td>
  84       &nbsp;
  85     </td>
  86     <td>
  87
  88 <p>
  89 Defined RtError types.
  90 <p>
  91 <dl compact><dt><b>Enumerator: </b></dt><dd>
  92 <table border="0" cellspacing="2" cellpadding="0">
  93 <tr><td valign="top"><em><a class="anchor" name="w11w0"></a><!-- doxytag: member="WARNING" ref="w11w0" args="" -->WARNING</em>&nbsp;</td><td>
  94 A non-critical error. </td></tr>
  95 <tr><td valign="top"><em><a class="anchor" name="w11w1"></a><!-- doxytag: member="DEBUG_WARNING" ref="w11w1" args="" -->DEBUG_WARNING</em>&nbsp;</td><td>
  96 A non-critical error which might be useful for debugging. </td></tr>
  97 <tr><td valign="top"><em><a class="anchor" name="w11w2"></a><!-- doxytag: member="UNSPECIFIED" ref="w11w2" args="" -->UNSPECIFIED</em>&nbsp;</td><td>
  98 The default, unspecified error type. </td></tr>
  99 <tr><td valign="top"><em><a class="anchor" name="w11w3"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="w11w3" args="" -->NO_DEVICES_FOUND</em>&nbsp;</td><td>
 100 No devices found on system. </td></tr>
 101 <tr><td valign="top"><em><a class="anchor" name="w11w4"></a><!-- doxytag: member="INVALID_DEVICE" ref="w11w4" args="" -->INVALID_DEVICE</em>&nbsp;</td><td>
 102 An invalid device ID was specified. </td></tr>
 103 <tr><td valign="top"><em><a class="anchor" name="w11w5"></a><!-- doxytag: member="INVALID_STREAM" ref="w11w5" args="" -->INVALID_STREAM</em>&nbsp;</td><td>
 104 An invalid stream ID was specified. </td></tr>
 105 <tr><td valign="top"><em><a class="anchor" name="w11w6"></a><!-- doxytag: member="MEMORY_ERROR" ref="w11w6" args="" -->MEMORY_ERROR</em>&nbsp;</td><td>
 106 An error occured during memory allocation. </td></tr>
 107 <tr><td valign="top"><em><a class="anchor" name="w11w7"></a><!-- doxytag: member="INVALID_PARAMETER" ref="w11w7" args="" -->INVALID_PARAMETER</em>&nbsp;</td><td>
 108 An invalid parameter was specified to a function. </td></tr>
 109 <tr><td valign="top"><em><a class="anchor" name="w11w8"></a><!-- doxytag: member="DRIVER_ERROR" ref="w11w8" args="" -->DRIVER_ERROR</em>&nbsp;</td><td>
 110 A system driver error occured. </td></tr>
 111 <tr><td valign="top"><em><a class="anchor" name="w11w9"></a><!-- doxytag: member="SYSTEM_ERROR" ref="w11w9" args="" -->SYSTEM_ERROR</em>&nbsp;</td><td>
 112 A system error occured. </td></tr>
 113 <tr><td valign="top"><em><a class="anchor" name="w11w10"></a><!-- doxytag: member="THREAD_ERROR" ref="w11w10" args="" -->THREAD_ERROR</em>&nbsp;</td><td>
 114 A thread error occured. </td></tr>
 115 </table>
 116 </dl>
 117     </td>
 118   </tr>
 119 </table>
 120 <hr>The documentation for this class was generated from the following file:<ul>
 121 <li><a class="el" href="RtError_8h-source.html">RtError.h</a></ul>
 122 <HR>
 123
 124 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
 125   <td>&copy;2001-2005 Gary P. Scavone, McGill University. All Rights Reserved.<br>
 126   Maintained by Gary P. Scavone, <a href="mailto:gary@music.mcgill.ca">gary@music.mcgill.ca</a></td></tr>
 127 </table>
 128
 129 </BODY>
 130 </HTML>