<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Audaspace: Exception.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Audaspace  <span id="projectnumber">1.3.0</span> </div> <div id="projectbrief">A high level audio library.</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="headertitle"> <div class="title">Exception.h</div> </div> </div><!--header--> <div class="contents"> <a href="Exception_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright 2009-2016 Jörg Müller</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> *</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> </div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifdef _MSC_VER</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define AUD_NOEXCEPT</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63"> 26</a></span> <span class="preprocessor">#define AUD_NOEXCEPT noexcept</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="Audaspace_8h.html">Audaspace.h</a>"</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <exception></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="Exception_8h.html#a8659527260f6d0fcdb3a5bca7adcb815"> 41</a></span> <span class="preprocessor">#define AUD_THROW(exception, message) { throw exception(message, __FILE__, __LINE__); }</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <a class="code" href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="classException.html"> 48</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classException.html">Exception</a> : <span class="keyword">public</span> std::exception</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> {</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">protected</span>:</div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classException.html#a492fd40f8daf552af168dde3c41a9143"> 52</a></span>  <span class="keyword">const</span> std::string <a class="code" href="classException.html#a492fd40f8daf552af168dde3c41a9143">m_message</a>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div><div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classException.html#a92baabd06360c37494caeb8d2f886899"> 55</a></span>  <span class="keyword">const</span> std::string <a class="code" href="classException.html#a92baabd06360c37494caeb8d2f886899">m_file</a>;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="classException.html#acd64e56acaee71be15d822db94f60ae9"> 58</a></span>  <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classException.html#acd64e56acaee71be15d822db94f60ae9">m_line</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classException.html">Exception</a>(<span class="keyword">const</span> <a class="code" href="classException.html">Exception</a>& exception);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <a class="code" href="classException.html">Exception</a>(std::string message, std::string file, <span class="keywordtype">int</span> line);</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> ~<a class="code" href="classException.html">Exception</a>() <a class="code" href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63">AUD_NOEXCEPT</a>;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  virtual const <span class="keywordtype">char</span>* what() const <a class="code" href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63">AUD_NOEXCEPT</a>;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  virtual std::<span class="keywordtype">string</span> getDebugMessage() const;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  const std::<span class="keywordtype">string</span>& getMessage() const;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  const std::<span class="keywordtype">string</span>& getFile() const;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  <span class="keywordtype">int</span> getLine() const;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> };</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classFileException.html"> 114</a></span> class <a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classFileException.html">FileException</a> : public <a class="code" href="classException.html">Exception</a></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> {</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <a class="code" href="classFileException.html">FileException</a>(std::string message, std::string file, <span class="keywordtype">int</span> line);</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <a class="code" href="classFileException.html">FileException</a>(<span class="keyword">const</span> <a class="code" href="classFileException.html">FileException</a>& exception);</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  ~<a class="code" href="classFileException.html">FileException</a>() <a class="code" href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63">AUD_NOEXCEPT</a>;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> };</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="classDeviceException.html"> 139</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classDeviceException.html">DeviceException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> {</div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="classDeviceException.html">DeviceException</a>(std::string message, std::string file, <span class="keywordtype">int</span> line);</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <a class="code" href="classDeviceException.html">DeviceException</a>(<span class="keyword">const</span> <a class="code" href="classDeviceException.html">DeviceException</a>& exception);</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  ~<a class="code" href="classDeviceException.html">DeviceException</a>() <a class="code" href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63">AUD_NOEXCEPT</a>;</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> };</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00165"></a><span class="lineno"><a class="line" href="classStateException.html"> 165</a></span> <span class="keyword">class </span><a class="code" href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a> <a class="code" href="classStateException.html">StateException</a> : <span class="keyword">public</span> <a class="code" href="classException.html">Exception</a></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> {</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  <a class="code" href="classStateException.html">StateException</a>(std::string message, std::string file, <span class="keywordtype">int</span> line);</div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> </div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <a class="code" href="classStateException.html">StateException</a>(<span class="keyword">const</span> <a class="code" href="classStateException.html">StateException</a>& exception);</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  ~<a class="code" href="classStateException.html">StateException</a>() <a class="code" href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63">AUD_NOEXCEPT</a>;</div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> };</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <a class="code" href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttc" id="classException_html_a492fd40f8daf552af168dde3c41a9143"><div class="ttname"><a href="classException.html#a492fd40f8daf552af168dde3c41a9143">Exception::m_message</a></div><div class="ttdeci">const std::string m_message</div><div class="ttdoc">A message describing the problem.</div><div class="ttdef"><b>Definition:</b> Exception.h:52</div></div> <div class="ttc" id="Audaspace_8h_html_acd7584504197a1397aaf57af797e1813"><div class="ttname"><a href="Audaspace_8h.html#acd7584504197a1397aaf57af797e1813">AUD_NAMESPACE_BEGIN</a></div><div class="ttdeci">#define AUD_NAMESPACE_BEGIN</div><div class="ttdoc">Opens the audaspace namespace aud.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:116</div></div> <div class="ttc" id="Exception_8h_html_a3a4ff5e1a5656b18b9d99bc2fc1c6b63"><div class="ttname"><a href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63">AUD_NOEXCEPT</a></div><div class="ttdeci">#define AUD_NOEXCEPT</div><div class="ttdoc">Compatibility macro for noexcept.</div><div class="ttdef"><b>Definition:</b> Exception.h:26</div></div> <div class="ttc" id="classDeviceException_html"><div class="ttname"><a href="classDeviceException.html">DeviceException</a></div><div class="ttdoc">The DeviceException class is used for error cases in connection with devices, which usually happens w...</div><div class="ttdef"><b>Definition:</b> Exception.h:139</div></div> <div class="ttc" id="Audaspace_8h_html_ad9080e3b9907fa3d0f5df561c65aa098"><div class="ttname"><a href="Audaspace_8h.html#ad9080e3b9907fa3d0f5df561c65aa098">AUD_API</a></div><div class="ttdeci">#define AUD_API</div><div class="ttdoc">Used for exporting symbols in the shared library.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:93</div></div> <div class="ttc" id="classFileException_html"><div class="ttname"><a href="classFileException.html">FileException</a></div><div class="ttdoc">The FileException class is used for error cases in which files cannot be read or written due to unkno...</div><div class="ttdef"><b>Definition:</b> Exception.h:114</div></div> <div class="ttc" id="classException_html_acd64e56acaee71be15d822db94f60ae9"><div class="ttname"><a href="classException.html#acd64e56acaee71be15d822db94f60ae9">Exception::m_line</a></div><div class="ttdeci">const int m_line</div><div class="ttdoc">The source code line from which the exception was thrown.</div><div class="ttdef"><b>Definition:</b> Exception.h:58</div></div> <div class="ttc" id="Audaspace_8h_html_a4cf7088a9bb0256563f28fd13c80b066"><div class="ttname"><a href="Audaspace_8h.html#a4cf7088a9bb0256563f28fd13c80b066">AUD_NAMESPACE_END</a></div><div class="ttdeci">#define AUD_NAMESPACE_END</div><div class="ttdoc">Closes the audaspace namespace aud.</div><div class="ttdef"><b>Definition:</b> Audaspace.h:119</div></div> <div class="ttc" id="classException_html"><div class="ttname"><a href="classException.html">Exception</a></div><div class="ttdoc">The Exception class is the general exception base class.</div><div class="ttdef"><b>Definition:</b> Exception.h:48</div></div> <div class="ttc" id="classException_html_a92baabd06360c37494caeb8d2f886899"><div class="ttname"><a href="classException.html#a92baabd06360c37494caeb8d2f886899">Exception::m_file</a></div><div class="ttdeci">const std::string m_file</div><div class="ttdoc">The source code file in which the exception was thrown.</div><div class="ttdef"><b>Definition:</b> Exception.h:55</div></div> <div class="ttc" id="Audaspace_8h_html"><div class="ttname"><a href="Audaspace_8h.html">Audaspace.h</a></div><div class="ttdoc">The main header file of the library defining the namespace and basic data types.</div></div> <div class="ttc" id="classStateException_html"><div class="ttname"><a href="classStateException.html">StateException</a></div><div class="ttdoc">The StateException class is used for error cases of sounds or readers with illegal states or requirem...</div><div class="ttdef"><b>Definition:</b> Exception.h:165</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.15 </small></address> </body> </html>