diff options
Diffstat (limited to 'doc/html/classRtError.html')
| -rw-r--r-- | doc/html/classRtError.html | 89 |
1 files changed, 45 insertions, 44 deletions
diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html index 7301c2c..23bfd0f 100644 --- a/doc/html/classRtError.html +++ b/doc/html/classRtError.html @@ -7,16 +7,16 @@ <CENTER> <a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> -<!-- Generated by Doxygen 1.3.4 --> -<h1>RtError Class Reference</h1>Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> & RtMidi. +<!-- Generated by Doxygen 1.4.4 --> +<h1>RtError Class Reference</h1><!-- doxytag: class="RtError" -->Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> & RtMidi. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="RtError_8h-source.html">RtError.h</a>></code> <p> -<a href="classRtError-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<a href="classRtError-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> -<tr><td colspan=2><br><h2>Public Types</h2></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#w11">Type</a> { <br> +<tr><td colspan="2"><br><h2>Public Types</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#w11">Type</a> { <br> <a class="el" href="classRtError.html#w11w0">WARNING</a>, <a class="el" href="classRtError.html#w11w1">DEBUG_WARNING</a>, <a class="el" href="classRtError.html#w11w2">UNSPECIFIED</a>, @@ -33,51 +33,52 @@ <br> }</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Defined RtError types. </em> <a href="#w11">More...</a><em><br><br></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" doxytag="RtError::RtError" ></a> - </td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#w11">Type</a> type=RtError::UNSPECIFIED)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Defined RtError types. <a href="classRtError.html#w11">More...</a><br></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="RtError::RtError" ref="a0" args="(const std::string &message, Type type=RtError::UNSPECIFIED)" --> + </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a0">RtError</a> (const std::string &message, <a class="el" href="classRtError.html#w11">Type</a> type=RtError::UNSPECIFIED)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">The constructor. <br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a1" doxytag="RtError::~RtError" ></a> -virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a1">~RtError</a> (void)</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="RtError::~RtError" ref="a1" args="(void)" --> +virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a1">~RtError</a> (void)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">The destructor. <br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a2" doxytag="RtError::printMessage" ></a> -virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a2">printMessage</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="RtError::printMessage" ref="a2" args="(void)" --> +virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a2">printMessage</a> (void)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Prints thrown error message to stderr. <br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a3" doxytag="RtError::getType" ></a> -virtual const <a class="el" href="classRtError.html#w11">Type</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a3">getType</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="RtError::getType" ref="a3" args="(void)" --> +virtual const <a class="el" href="classRtError.html#w11">Type</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a3">getType</a> (void)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message type. <br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a4" doxytag="RtError::getMessage" ></a> -virtual const std::string & </td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a4">getMessage</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="RtError::getMessage" ref="a4" args="(void)" --> +virtual const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a4">getMessage</a> (void)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message string. <br><br></td></tr> -<tr><td class="memItemLeft" nowrap align=right valign=top><a class="anchor" name="a5" doxytag="RtError::getMessageString" ></a> -virtual const char * </td><td class="memItemRight" valign=bottom><a class="el" href="classRtError.html#a5">getMessageString</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="RtError::getMessageString" ref="a5" args="(void)" --> +virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classRtError.html#a5">getMessageString</a> (void)</td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the thrown error message as a C string. <br><br></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> Exception handling class for <a class="el" href="classRtAudio.html">RtAudio</a> & RtMidi. <p> -The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w11">RtError::Type</a>. See the <a class="el" href="classRtAudio.html">RtAudio</a> and RtMidi documentation to know which methods can throw an RtError. +The RtError class is quite simple but it does allow errors to be "caught" by <a class="el" href="classRtError.html#w11">RtError::Type</a>. See the <a class="el" href="classRtAudio.html">RtAudio</a> and RtMidi documentation to know which methods can throw an RtError. <p> <hr><h2>Member Enumeration Documentation</h2> -<a class="anchor" name="w11" doxytag="RtError::Type" ></a><p> -<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> +<a class="anchor" name="w11"></a><!-- doxytag: member="RtError::Type" ref="w11" args="" --><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> - <td class="md" nowrap valign="top"> enum <a class="el" href="classRtError.html#w11">RtError::Type</a> + <td class="md" nowrap valign="top">enum <a class="el" href="classRtError.html#w11">RtError::Type</a> </td> + </tr> </table> </td> </tr> </table> -<table cellspacing=5 cellpadding=0 border=0> +<table cellspacing="5" cellpadding="0" border="0"> <tr> <td> @@ -87,29 +88,29 @@ The RtError class is quite simple but it does allow errors to be "caught" by <a <p> Defined RtError types. <p> -<dl compact><dt><b>Enumeration values: </b></dt><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><em><a class="anchor" name="w11w0" doxytag="WARNING" ></a>WARNING</em> </td><td> +<dl compact><dt><b>Enumerator: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="w11w0"></a><!-- doxytag: member="WARNING" ref="w11w0" args="" -->WARNING</em> </td><td> A non-critical error. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w1" doxytag="DEBUG_WARNING" ></a>DEBUG_WARNING</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w1"></a><!-- doxytag: member="DEBUG_WARNING" ref="w11w1" args="" -->DEBUG_WARNING</em> </td><td> A non-critical error which might be useful for debugging. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w2" doxytag="UNSPECIFIED" ></a>UNSPECIFIED</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w2"></a><!-- doxytag: member="UNSPECIFIED" ref="w11w2" args="" -->UNSPECIFIED</em> </td><td> The default, unspecified error type. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w3" doxytag="NO_DEVICES_FOUND" ></a>NO_DEVICES_FOUND</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w3"></a><!-- doxytag: member="NO_DEVICES_FOUND" ref="w11w3" args="" -->NO_DEVICES_FOUND</em> </td><td> No devices found on system. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w4" doxytag="INVALID_DEVICE" ></a>INVALID_DEVICE</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w4"></a><!-- doxytag: member="INVALID_DEVICE" ref="w11w4" args="" -->INVALID_DEVICE</em> </td><td> An invalid device ID was specified. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w5" doxytag="INVALID_STREAM" ></a>INVALID_STREAM</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w5"></a><!-- doxytag: member="INVALID_STREAM" ref="w11w5" args="" -->INVALID_STREAM</em> </td><td> An invalid stream ID was specified. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w6" doxytag="MEMORY_ERROR" ></a>MEMORY_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w6"></a><!-- doxytag: member="MEMORY_ERROR" ref="w11w6" args="" -->MEMORY_ERROR</em> </td><td> An error occured during memory allocation. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w7" doxytag="INVALID_PARAMETER" ></a>INVALID_PARAMETER</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w7"></a><!-- doxytag: member="INVALID_PARAMETER" ref="w11w7" args="" -->INVALID_PARAMETER</em> </td><td> An invalid parameter was specified to a function. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w8" doxytag="DRIVER_ERROR" ></a>DRIVER_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w8"></a><!-- doxytag: member="DRIVER_ERROR" ref="w11w8" args="" -->DRIVER_ERROR</em> </td><td> A system driver error occured. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w9" doxytag="SYSTEM_ERROR" ></a>SYSTEM_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w9"></a><!-- doxytag: member="SYSTEM_ERROR" ref="w11w9" args="" -->SYSTEM_ERROR</em> </td><td> A system error occured. </td></tr> -<tr><td valign=top><em><a class="anchor" name="w11w10" doxytag="THREAD_ERROR" ></a>THREAD_ERROR</em> </td><td> +<tr><td valign="top"><em><a class="anchor" name="w11w10"></a><!-- doxytag: member="THREAD_ERROR" ref="w11w10" args="" -->THREAD_ERROR</em> </td><td> A thread error occured. </td></tr> </table> </dl> @@ -121,7 +122,7 @@ A thread error occured. </td></tr> <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2001-2004 Gary P. Scavone, McGill University. All Rights Reserved.<br> + <td>©2001-2005 Gary P. Scavone, McGill University. All Rights Reserved.<br> Maintained by Gary P. Scavone, <a href="mailto:gary@music.mcgill.ca">gary@music.mcgill.ca</a></td></tr> </table> |