<!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: StateException Class Reference</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> <!-- 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><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="classStateException-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">StateException Class Reference</div> </div> </div><!--header--> <div class="contents"> <p>The <a class="el" href="classStateException.html" title="The StateException class is used for error cases of sounds or readers with illegal states or requirem...">StateException</a> class is used for error cases of sounds or readers with illegal states or requirements for states of dependent classes. <a href="classStateException.html#details">More...</a></p> <p><code>#include <<a class="el" href="Exception_8h_source.html">Exception.h</a>></code></p> <div class="dynheader"> Inheritance diagram for StateException:</div> <div class="dyncontent"> <div class="center"><img src="classStateException__inherit__graph.png" border="0" usemap="#StateException_inherit__map" alt="Inheritance graph"/></div> <map name="StateException_inherit__map" id="StateException_inherit__map"> <area shape="rect" title="The StateException class is used for error cases of sounds or readers with illegal states or requirem..." alt="" coords="5,155,119,181"/> <area shape="rect" href="classException.html" title="The Exception class is the general exception base class." alt="" coords="21,80,103,107"/> <area shape="rect" title=" " alt="" coords="9,5,115,32"/> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a8013d357b20ba27dc4459b4fa4beec19"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStateException.html#a8013d357b20ba27dc4459b4fa4beec19">StateException</a> (std::string message, std::string file, int line)</td></tr> <tr class="memdesc:a8013d357b20ba27dc4459b4fa4beec19"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classStateException.html" title="The StateException class is used for error cases of sounds or readers with illegal states or requirem...">StateException</a> object. <a href="#a8013d357b20ba27dc4459b4fa4beec19">More...</a><br /></td></tr> <tr class="separator:a8013d357b20ba27dc4459b4fa4beec19"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1671ffc40f90672aae7af39065d9453f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classStateException.html#a1671ffc40f90672aae7af39065d9453f">StateException</a> (const <a class="el" href="classStateException.html">StateException</a> &exception)</td></tr> <tr class="memdesc:a1671ffc40f90672aae7af39065d9453f"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#a1671ffc40f90672aae7af39065d9453f">More...</a><br /></td></tr> <tr class="separator:a1671ffc40f90672aae7af39065d9453f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_classException"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classException')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classException.html">Exception</a></td></tr> <tr class="memitem:ad6ccad1ce98465e9fdc2c24230dbfca8 inherit pub_methods_classException"><td class="memItemLeft" align="right" valign="top"><a id="ad6ccad1ce98465e9fdc2c24230dbfca8"></a> virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#ad6ccad1ce98465e9fdc2c24230dbfca8">~Exception</a> () <a class="el" href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63">AUD_NOEXCEPT</a></td></tr> <tr class="memdesc:ad6ccad1ce98465e9fdc2c24230dbfca8 inherit pub_methods_classException"><td class="mdescLeft"> </td><td class="mdescRight">Destroys the object. <br /></td></tr> <tr class="separator:ad6ccad1ce98465e9fdc2c24230dbfca8 inherit pub_methods_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a614290750b40ac6d7fcab144a58696b5 inherit pub_methods_classException"><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#a614290750b40ac6d7fcab144a58696b5">what</a> () const <a class="el" href="Exception_8h.html#a3a4ff5e1a5656b18b9d99bc2fc1c6b63">AUD_NOEXCEPT</a></td></tr> <tr class="memdesc:a614290750b40ac6d7fcab144a58696b5 inherit pub_methods_classException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the error message. <a href="classException.html#a614290750b40ac6d7fcab144a58696b5">More...</a><br /></td></tr> <tr class="separator:a614290750b40ac6d7fcab144a58696b5 inherit pub_methods_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a556fcdcfe0e58e2ef8709adf5d07f5cc inherit pub_methods_classException"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#a556fcdcfe0e58e2ef8709adf5d07f5cc">getDebugMessage</a> () const</td></tr> <tr class="memdesc:a556fcdcfe0e58e2ef8709adf5d07f5cc inherit pub_methods_classException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the error message plus file and line number for debugging purposes. <a href="classException.html#a556fcdcfe0e58e2ef8709adf5d07f5cc">More...</a><br /></td></tr> <tr class="separator:a556fcdcfe0e58e2ef8709adf5d07f5cc inherit pub_methods_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acddc608f0463722b5c55d4aa9bf4c20d inherit pub_methods_classException"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#acddc608f0463722b5c55d4aa9bf4c20d">getMessage</a> () const</td></tr> <tr class="memdesc:acddc608f0463722b5c55d4aa9bf4c20d inherit pub_methods_classException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the error message. <a href="classException.html#acddc608f0463722b5c55d4aa9bf4c20d">More...</a><br /></td></tr> <tr class="separator:acddc608f0463722b5c55d4aa9bf4c20d inherit pub_methods_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a8d7803f4034e5da688bbe3dca9715b6a inherit pub_methods_classException"><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#a8d7803f4034e5da688bbe3dca9715b6a">getFile</a> () const</td></tr> <tr class="memdesc:a8d7803f4034e5da688bbe3dca9715b6a inherit pub_methods_classException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the file in which the exception was thrown. <a href="classException.html#a8d7803f4034e5da688bbe3dca9715b6a">More...</a><br /></td></tr> <tr class="separator:a8d7803f4034e5da688bbe3dca9715b6a inherit pub_methods_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:add9b14e9f5a48bdaf05487d6a13378be inherit pub_methods_classException"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#add9b14e9f5a48bdaf05487d6a13378be">getLine</a> () const</td></tr> <tr class="memdesc:add9b14e9f5a48bdaf05487d6a13378be inherit pub_methods_classException"><td class="mdescLeft"> </td><td class="mdescRight">Returns the line where the exception was originally thrown. <a href="classException.html#add9b14e9f5a48bdaf05487d6a13378be">More...</a><br /></td></tr> <tr class="separator:add9b14e9f5a48bdaf05487d6a13378be inherit pub_methods_classException"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pro_methods_classException"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classException')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="classException.html">Exception</a></td></tr> <tr class="memitem:afeb97c421adf460c70903ec07b12fcdc inherit pro_methods_classException"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#afeb97c421adf460c70903ec07b12fcdc">Exception</a> (const <a class="el" href="classException.html">Exception</a> &exception)</td></tr> <tr class="memdesc:afeb97c421adf460c70903ec07b12fcdc inherit pro_methods_classException"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="classException.html#afeb97c421adf460c70903ec07b12fcdc">More...</a><br /></td></tr> <tr class="separator:afeb97c421adf460c70903ec07b12fcdc inherit pro_methods_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4ea0d287d4a966ab9361d8a9f9542231 inherit pro_methods_classException"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#a4ea0d287d4a966ab9361d8a9f9542231">Exception</a> (std::string message, std::string file, int line)</td></tr> <tr class="memdesc:a4ea0d287d4a966ab9361d8a9f9542231 inherit pro_methods_classException"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="classException.html" title="The Exception class is the general exception base class.">Exception</a> object. <a href="classException.html#a4ea0d287d4a966ab9361d8a9f9542231">More...</a><br /></td></tr> <tr class="separator:a4ea0d287d4a966ab9361d8a9f9542231 inherit pro_methods_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_attribs_classException"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classException')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="classException.html">Exception</a></td></tr> <tr class="memitem:a492fd40f8daf552af168dde3c41a9143 inherit pro_attribs_classException"><td class="memItemLeft" align="right" valign="top"><a id="a492fd40f8daf552af168dde3c41a9143"></a> const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#a492fd40f8daf552af168dde3c41a9143">m_message</a></td></tr> <tr class="memdesc:a492fd40f8daf552af168dde3c41a9143 inherit pro_attribs_classException"><td class="mdescLeft"> </td><td class="mdescRight">A message describing the problem. <br /></td></tr> <tr class="separator:a492fd40f8daf552af168dde3c41a9143 inherit pro_attribs_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a92baabd06360c37494caeb8d2f886899 inherit pro_attribs_classException"><td class="memItemLeft" align="right" valign="top"><a id="a92baabd06360c37494caeb8d2f886899"></a> const std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#a92baabd06360c37494caeb8d2f886899">m_file</a></td></tr> <tr class="memdesc:a92baabd06360c37494caeb8d2f886899 inherit pro_attribs_classException"><td class="mdescLeft"> </td><td class="mdescRight">The source code file in which the exception was thrown. <br /></td></tr> <tr class="separator:a92baabd06360c37494caeb8d2f886899 inherit pro_attribs_classException"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acd64e56acaee71be15d822db94f60ae9 inherit pro_attribs_classException"><td class="memItemLeft" align="right" valign="top"><a id="acd64e56acaee71be15d822db94f60ae9"></a> const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classException.html#acd64e56acaee71be15d822db94f60ae9">m_line</a></td></tr> <tr class="memdesc:acd64e56acaee71be15d822db94f60ae9 inherit pro_attribs_classException"><td class="mdescLeft"> </td><td class="mdescRight">The source code line from which the exception was thrown. <br /></td></tr> <tr class="separator:acd64e56acaee71be15d822db94f60ae9 inherit pro_attribs_classException"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>The <a class="el" href="classStateException.html" title="The StateException class is used for error cases of sounds or readers with illegal states or requirem...">StateException</a> class is used for error cases of sounds or readers with illegal states or requirements for states of dependent classes. </p> <p>It is used for example when an effect reader needs a specific specification from its input. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a8013d357b20ba27dc4459b4fa4beec19"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8013d357b20ba27dc4459b4fa4beec19">◆ </a></span>StateException() <span class="overload">[1/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">StateException::StateException </td> <td>(</td> <td class="paramtype">std::string </td> <td class="paramname"><em>message</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">std::string </td> <td class="paramname"><em>file</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>line</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Creates a new <a class="el" href="classStateException.html" title="The StateException class is used for error cases of sounds or readers with illegal states or requirem...">StateException</a> object. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">message</td><td>A message describing the problem. </td></tr> <tr><td class="paramname">file</td><td>The source code file in which the exception was thrown. </td></tr> <tr><td class="paramname">line</td><td>The source code line from which the exception was thrown. </td></tr> </table> </dd> </dl> </div> </div> <a id="a1671ffc40f90672aae7af39065d9453f"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1671ffc40f90672aae7af39065d9453f">◆ </a></span>StateException() <span class="overload">[2/2]</span></h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">StateException::StateException </td> <td>(</td> <td class="paramtype">const <a class="el" href="classStateException.html">StateException</a> & </td> <td class="paramname"><em>exception</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p>Copy constructor. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">exception</td><td>The exception to be copied. </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="Exception_8h_source.html">Exception.h</a></li> </ul> </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>