mirror of
https://github.com/thestk/stk
synced 2026-01-13 21:11:53 +00:00
58 lines
4.4 KiB
HTML
58 lines
4.4 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.4.4 -->
|
|
<h1>StkError Class Reference</h1><!-- doxytag: class="StkError" --><code>#include <<a class="el" href="Stk_8h-source.html">Stk.h</a>></code>
|
|
<p>
|
|
<a href="classStkError-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
STK error handling class.
|
|
<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>
|
|
<table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="StkError::StkError" ref="a0" args="(const std::string &message, Type type=StkError::UNSPECIFIED)" -->
|
|
</td><td class="memItemRight" valign="bottom"><a class="el" href="classStkError.html#a0">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" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="StkError::~StkError" ref="a1" args="(void)" -->
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classStkError.html#a1">~StkError</a> (void)</td></tr>
|
|
|
|
<tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="StkError::printMessage" ref="a2" args="(void)" -->
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classStkError.html#a2">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" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="StkError::getType" ref="a3" args="(void)" -->
|
|
virtual const Type & </td><td class="memItemRight" valign="bottom"><a class="el" href="classStkError.html#a3">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" nowrap align="right" valign="top"><a class="anchor" name="a4"></a><!-- doxytag: member="StkError::getMessage" ref="a4" args="(void)" -->
|
|
virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classStkError.html#a4">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" nowrap align="right" valign="top"><a class="anchor" name="a5"></a><!-- doxytag: member="StkError::getMessageCString" ref="a5" args="(void)" -->
|
|
virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classStkError.html#a5">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>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="Stk_8h-source.html">Stk.h</a></ul>
|
|
<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-2007 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
|
</table>
|
|
|
|
</BODY>
|
|
</HTML>
|