Release 4.0.1 tarball
[rtaudio.git] / doc / html / RtError_8h-source.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.4.4 -->
12 <h1>RtError.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/************************************************************************/</span>
13 <a name="l00010"></a>00010 <span class="comment">/************************************************************************/</span>
14 <a name="l00011"></a>00011 
15 <a name="l00012"></a>00012 <span class="preprocessor">#ifndef RTERROR_H</span>
16 <a name="l00013"></a>00013 <span class="preprocessor"></span><span class="preprocessor">#define RTERROR_H</span>
17 <a name="l00014"></a>00014 <span class="preprocessor"></span>
18 <a name="l00015"></a>00015 <span class="preprocessor">#include &lt;exception&gt;</span>
19 <a name="l00016"></a>00016 <span class="preprocessor">#include &lt;iostream&gt;</span>
20 <a name="l00017"></a>00017 <span class="preprocessor">#include &lt;string&gt;</span>
21 <a name="l00018"></a>00018 
22 <a name="l00019"></a><a class="code" href="classRtError.html">00019</a> <span class="keyword">class </span><a class="code" href="classRtError.html">RtError</a> : <span class="keyword">public</span> std::exception
23 <a name="l00020"></a>00020 {
24 <a name="l00021"></a>00021  <span class="keyword">public</span>:
25 <a name="l00023"></a><a class="code" href="classRtError.html#w11">00023</a>   <span class="keyword">enum</span> <a class="code" href="classRtError.html#w11">Type</a> {
26 <a name="l00024"></a>00024     <a class="code" href="classRtError.html#w11w0">WARNING</a>,           
27 <a name="l00025"></a>00025     <a class="code" href="classRtError.html#w11w1">DEBUG_WARNING</a>,     
28 <a name="l00026"></a>00026     <a class="code" href="classRtError.html#w11w2">UNSPECIFIED</a>,       
29 <a name="l00027"></a>00027     <a class="code" href="classRtError.html#w11w3">NO_DEVICES_FOUND</a>,  
30 <a name="l00028"></a>00028     <a class="code" href="classRtError.html#w11w4">INVALID_DEVICE</a>,    
31 <a name="l00029"></a>00029     <a class="code" href="classRtError.html#w11w5">MEMORY_ERROR</a>,      
32 <a name="l00030"></a>00030     <a class="code" href="classRtError.html#w11w6">INVALID_PARAMETER</a>, 
33 <a name="l00031"></a>00031     <a class="code" href="classRtError.html#w11w7">INVALID_USE</a>,       
34 <a name="l00032"></a>00032     <a class="code" href="classRtError.html#w11w8">DRIVER_ERROR</a>,      
35 <a name="l00033"></a>00033     <a class="code" href="classRtError.html#w11w9">SYSTEM_ERROR</a>,      
36 <a name="l00034"></a><a class="code" href="classRtError.html#w11w10">00034</a>     <a class="code" href="classRtError.html#w11w10">THREAD_ERROR</a>       
37 <a name="l00035"></a>00035   };
38 <a name="l00036"></a>00036 
39 <a name="l00038"></a><a class="code" href="classRtError.html#a0">00038</a>   <a class="code" href="classRtError.html#a0">RtError</a>( <span class="keyword">const</span> std::string&amp; message, <a class="code" href="classRtError.html#w11">Type</a> type = <a class="code" href="classRtError.html#w11w2">RtError::UNSPECIFIED</a> ) throw() : message_(message), type_(type) {}
40 <a name="l00039"></a>00039  
41 <a name="l00041"></a><a class="code" href="classRtError.html#a1">00041</a>   <span class="keyword">virtual</span> <a class="code" href="classRtError.html#a1">~RtError</a>( <span class="keywordtype">void</span> ) throw() {}
42 <a name="l00042"></a>00042 
43 <a name="l00044"></a><a class="code" href="classRtError.html#a2">00044</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classRtError.html#a2">printMessage</a>( <span class="keywordtype">void</span> ) throw() { std::cerr &lt;&lt; <span class="charliteral">'\n'</span> &lt;&lt; message_ &lt;&lt; <span class="stringliteral">"\n\n"</span>; }
44 <a name="l00045"></a>00045 
45 <a name="l00047"></a><a class="code" href="classRtError.html#a3">00047</a>   <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classRtError.html#w11">Type</a>&amp; <a class="code" href="classRtError.html#a3">getType</a>(<span class="keywordtype">void</span>) throw() { <span class="keywordflow">return</span> type_; }
46 <a name="l00048"></a>00048 
47 <a name="l00050"></a><a class="code" href="classRtError.html#a4">00050</a>   <span class="keyword">virtual</span> <span class="keyword">const</span> std::string&amp; <a class="code" href="classRtError.html#a4">getMessage</a>(<span class="keywordtype">void</span>) throw() { <span class="keywordflow">return</span> message_; }
48 <a name="l00051"></a>00051 
49 <a name="l00053"></a><a class="code" href="classRtError.html#a5">00053</a>   <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classRtError.html#a5">what</a>( <span class="keywordtype">void</span> ) const throw() { <span class="keywordflow">return</span> message_.c_str(); }
50 <a name="l00054"></a>00054 
51 <a name="l00055"></a>00055  <span class="keyword">protected</span>:
52 <a name="l00056"></a>00056   std::string message_;
53 <a name="l00057"></a>00057   <a class="code" href="classRtError.html#w11">Type</a> type_;
54 <a name="l00058"></a>00058 };
55 <a name="l00059"></a>00059 
56 <a name="l00060"></a>00060 <span class="preprocessor">#endif</span>
57 </pre></div><HR>
58
59 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
60   <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>
61 </table>
62
63 </BODY>
64 </HTML>