mirror of
https://github.com/thestk/stk
synced 2026-01-13 13:01:52 +00:00
59 lines
5.2 KiB
HTML
59 lines
5.2 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
|
|
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
|
|
</HEAD>
|
|
<BODY BGCOLOR="#FFFFFF">
|
|
<CENTER>
|
|
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
|
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
|
<HR>
|
|
<!-- Generated by Doxygen 1.6.2 -->
|
|
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1StkError.html">StkError</a>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>stk::StkError Class Reference</h1><!-- doxytag: class="stk::StkError" -->
|
|
<p>STK error handling class.
|
|
<a href="#_details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="Stk_8h_source.html">Stk.h</a>></code></p>
|
|
|
|
<p><a href="classstk_1_1StkError-members.html">List of all members.</a></p>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6cbc80df11b385b20d244327fb74abb"></a><!-- doxytag: member="stk::StkError::StkError" ref="ab6cbc80df11b385b20d244327fb74abb" args="(const std::string &message, Type type=StkError::UNSPECIFIED)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StkError.html#ab6cbc80df11b385b20d244327fb74abb">StkError</a> (const std::string &message, Type type=StkError::UNSPECIFIED)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0639b3a9354a0f84a9338d1c9b87464"></a><!-- doxytag: member="stk::StkError::~StkError" ref="ab0639b3a9354a0f84a9338d1c9b87464" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StkError.html#ab0639b3a9354a0f84a9338d1c9b87464">~StkError</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a337437a729f03d48fc56277037ac6fdc"></a><!-- doxytag: member="stk::StkError::printMessage" ref="a337437a729f03d48fc56277037ac6fdc" args="(void)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StkError.html#a337437a729f03d48fc56277037ac6fdc">printMessage</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints thrown error message to stderr. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae641cf5ed2b756adbf02fc668fac53e"></a><!-- doxytag: member="stk::StkError::getType" ref="aae641cf5ed2b756adbf02fc668fac53e" args="(void)" -->
|
|
virtual const Type & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StkError.html#aae641cf5ed2b756adbf02fc668fac53e">getType</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message type. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac691cbffe442d9e0760978146df5d9fb"></a><!-- doxytag: member="stk::StkError::getMessage" ref="ac691cbffe442d9e0760978146df5d9fb" args="(void)" -->
|
|
virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StkError.html#ac691cbffe442d9e0760978146df5d9fb">getMessage</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message string. <br/></td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae802643199c86a797f7adebe109d84bf"></a><!-- doxytag: member="stk::StkError::getMessageCString" ref="ae802643199c86a797f7adebe109d84bf" args="(void)" -->
|
|
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1StkError.html#ae802643199c86a797f7adebe109d84bf">getMessageCString</a> (void)</td></tr>
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message as a C string. <br/></td></tr>
|
|
</table>
|
|
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
|
<p>STK error handling class. </p>
|
|
<p>This is a fairly abstract exception handling class. There could be sub-classes to take care of more specific error conditions ... or not. </p>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Stk_8h_source.html">Stk.h</a></li>
|
|
</ul>
|
|
</div>
|
|
<HR>
|
|
|
|
<table>
|
|
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
|
<tr><td>©1995-2011 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|