falkTX
/
rtaudio
mirror of https://github.com/falkTX/rtaudio
1
0
Fork 0
Code Releases 27 Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
28 Commits
5 Branches
2.2MB
Tree: 0876bbd0ba
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '0876bbd0ba'
${ noResults }
rtaudio/doc/html/classRtError.html

125 lines
8.0KB
Raw Blame History 

  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.4.4 -->

  12. <h1>RtError Class Reference</h1><!-- doxytag: class="RtError" -->Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> &amp; RtMidi.  

  13. <a href="#_details">More...</a>

  14. <p>

  15. <code>#include &lt;<a class="el" href="RtError_8h-source.html">RtError.h</a>&gt;</code>

  16. <p>

  17. <a href="classRtError-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">

  18. <tr><td></td></tr>

  19. <tr><td colspan="2"><br><h2>Public Types</h2></td></tr>

  20. <tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#w9">Type</a> { <br>

  21. &nbsp;&nbsp;<a class="el" href="classRtError.html#w9w0">UNSPECIFIED</a>, 

  22. <a class="el" href="classRtError.html#w9w1">NO_DEVICES_FOUND</a>, 

  23. <a class="el" href="classRtError.html#w9w2">INVALID_DEVICE</a>, 

  24. <a class="el" href="classRtError.html#w9w3">MEMORY_ERROR</a>, 

  25. <br>

  26. &nbsp;&nbsp;<a class="el" href="classRtError.html#w9w4">INVALID_PARAMETER</a>, 

  27. <a class="el" href="classRtError.html#w9w5">INVALID_USE</a>, 

  28. <a class="el" href="classRtError.html#w9w6">DRIVER_ERROR</a>, 

  29. <a class="el" href="classRtError.html#w9w7">SYSTEM_ERROR</a>, 

  30. <br>

  31. &nbsp;&nbsp;<a class="el" href="classRtError.html#w9w8">THREAD_ERROR</a>

  32. <br>

  33.  }</td></tr>

  34. 

  35. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Defined RtError types.  <a href="classRtError.html#w9">More...</a><br></td></tr>

  36. <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>

  37. <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)" -->

  38. &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#w9">Type</a> type=RtError::UNSPECIFIED)  throw ()</td></tr>

  39. 

  40. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The constructor. <br></td></tr>

  41. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="RtError::~RtError" ref="a1" args="(void)" -->

  42. virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a1">~RtError</a> (void)  throw ()</td></tr>

  43. 

  44. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The destructor. <br></td></tr>

  45. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="RtError::printMessage" ref="a2" args="(void)" -->

  46. virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a2">printMessage</a> (void)  throw ()</td></tr>

  47. 

  48. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prints thrown error message to stderr. <br></td></tr>

  49. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="RtError::getType" ref="a3" args="(void)" -->

  50. virtual const <a class="el" href="classRtError.html#w9">Type</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3">getType</a> (void)  throw ()</td></tr>

  51. 

  52. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message type. <br></td></tr>

  53. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="RtError::getMessage" ref="a4" args="(void)" -->

  54. virtual const std::string &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a4">getMessage</a> (void)  throw ()</td></tr>

  55. 

  56. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message string. <br></td></tr>

  57. <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="RtError::what" ref="a5" args="(void) const " -->

  58. virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a5">what</a> (void) const   throw ()</td></tr>

  59. 

  60. <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the thrown error message as a c-style string. <br></td></tr>

  61. </table>

  62. <hr><a name="_details"></a><h2>Detailed Description</h2>

  63. Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> &amp; RtMidi. 

  64. <p>

  65. The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w9">RtError::Type</a>. See the <a class="el" href="classRtAudio.html">RtAudio</a> and RtMidi documentation to know which methods can throw an RtError.

  66. <p>

  67. <hr><h2>Member Enumeration Documentation</h2>

  68. <a class="anchor" name="w9"></a><!-- doxytag: member="RtError::Type" ref="w9" args="" --><p>

  69. <table class="mdTable" cellpadding="2" cellspacing="0">

  70.   <tr>

  71.     <td class="mdRow">

  72.       <table cellpadding="0" cellspacing="0" border="0">

  73.         <tr>

  74.           <td class="md" nowrap valign="top">enum <a class="el" href="classRtError.html#w9">RtError::Type</a>          </td>

  75.         </tr>

  76.       </table>

  77.     </td>

  78.   </tr>

  79. </table>

  80. <table cellspacing="5" cellpadding="0" border="0">

  81.   <tr>

  82.     <td>

  83.       &nbsp;

  84.     </td>

  85.     <td>

  86. 

  87. <p>

  88. Defined RtError types. 

  89. <p>

  90. <dl compact><dt><b>Enumerator: </b></dt><dd>

  91. <table border="0" cellspacing="2" cellpadding="0">

  92. <tr><td valign="top"><em><a class="anchor" name="w9w0"></a><!-- doxytag: member="UNSPECIFIED" ref="w9w0" args="" -->UNSPECIFIED</em>&nbsp;</td><td>

  93. The default, unspecified error type. </td></tr>

  94. <tr><td valign="top"><em><a class="anchor" name="w9w1"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="w9w1" args="" -->NO_DEVICES_FOUND</em>&nbsp;</td><td>

  95. No devices found on system. </td></tr>

  96. <tr><td valign="top"><em><a class="anchor" name="w9w2"></a><!-- doxytag: member="INVALID_DEVICE" ref="w9w2" args="" -->INVALID_DEVICE</em>&nbsp;</td><td>

  97. An invalid device ID was specified. </td></tr>

  98. <tr><td valign="top"><em><a class="anchor" name="w9w3"></a><!-- doxytag: member="MEMORY_ERROR" ref="w9w3" args="" -->MEMORY_ERROR</em>&nbsp;</td><td>

  99. An error occured during memory allocation. </td></tr>

  100. <tr><td valign="top"><em><a class="anchor" name="w9w4"></a><!-- doxytag: member="INVALID_PARAMETER" ref="w9w4" args="" -->INVALID_PARAMETER</em>&nbsp;</td><td>

  101. An invalid parameter was specified to a function. </td></tr>

  102. <tr><td valign="top"><em><a class="anchor" name="w9w5"></a><!-- doxytag: member="INVALID_USE" ref="w9w5" args="" -->INVALID_USE</em>&nbsp;</td><td>

  103. The function was called incorrectly. </td></tr>

  104. <tr><td valign="top"><em><a class="anchor" name="w9w6"></a><!-- doxytag: member="DRIVER_ERROR" ref="w9w6" args="" -->DRIVER_ERROR</em>&nbsp;</td><td>

  105. A system driver error occured. </td></tr>

  106. <tr><td valign="top"><em><a class="anchor" name="w9w7"></a><!-- doxytag: member="SYSTEM_ERROR" ref="w9w7" args="" -->SYSTEM_ERROR</em>&nbsp;</td><td>

  107. A system error occured. </td></tr>

  108. <tr><td valign="top"><em><a class="anchor" name="w9w8"></a><!-- doxytag: member="THREAD_ERROR" ref="w9w8" args="" -->THREAD_ERROR</em>&nbsp;</td><td>

  109. A thread error occured. </td></tr>

  110. </table>

  111. </dl>

  112.     </td>

  113.   </tr>

  114. </table>

  115. <hr>The documentation for this class was generated from the following file:<ul>

  116. <li><a class="el" href="RtError_8h-source.html">RtError.h</a></ul>

  117. <HR>

  118. 

  119. <table><tr><td><img src="../images/mcgill.gif" width=165></td>

  120.   <td>&copy;2001-2007 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>

  121. </table>

  122. 

  123. </BODY>

  124. </HTML>