From 4f7c61bd5ca4816d7d8911f457f84127c95cf688 Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Fri, 11 Oct 2013 00:04:56 +0200 Subject: Release 3.0.2 tarball --- doc/html/classRtError.html | 89 +++++++++++++++++++++++----------------------- 1 file changed, 45 insertions(+), 44 deletions(-) (limited to 'doc/html/classRtError.html') 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 @@
Tutorial   Class/Enum List   File List   Compound Members  

- -

RtError Class Reference

Exception handling class for RtAudio & RtMidi. + +

RtError Class Reference

Exception handling class for RtAudio & RtMidi. More...

#include <RtError.h>

-List of all members. +List of all members.
- - + - - - + + + - - + + - - + + - - + + - - + + - - + + - +

Public Types

enum  Type {
+

Public Types

enum  Type {
  WARNING, DEBUG_WARNING, UNSPECIFIED, @@ -33,51 +33,52 @@
}
 Defined RtError types. More...


Public Member Functions

RtError (const std::string &message, Type type=RtError::UNSPECIFIED)
 Defined RtError types. More...

Public Member Functions

RtError (const std::string &message, Type type=RtError::UNSPECIFIED)
 The constructor.

-virtual ~RtError (void)
 The constructor.
+virtual ~RtError (void)
 The destructor.

-virtual void printMessage (void)
 The destructor.
+virtual void printMessage (void)
 Prints thrown error message to stderr.

-virtual const TypegetType (void)
 Prints thrown error message to stderr.
+virtual const TypegetType (void)
 Returns the thrown error message type.

-virtual const std::string & getMessage (void)
 Returns the thrown error message type.
+virtual const std::string & getMessage (void)
 Returns the thrown error message string.

-virtual const char * getMessageString (void)
 Returns the thrown error message string.
+virtual const char * getMessageString (void)
 Returns the thrown error message as a C string.

 Returns the thrown error message as a C string.


Detailed Description

Exception handling class for RtAudio & RtMidi.

-The RtError class is quite simple but it does allow errors to be "caught" by RtError::Type. See the RtAudio 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 RtError::Type. See the RtAudio and RtMidi documentation to know which methods can throw an RtError.


Member Enumeration Documentation

-

- +

+

- +
enum RtError::Type + enum RtError::Type
- +
  @@ -87,29 +88,29 @@ The RtError class is quite simple but it does allow errors to be "caught" by Defined RtError types.

-

Enumeration values:
- -
WARNING  +
Enumerator:
+ + - - - - - - - - - -
WARNING  A non-critical error.
DEBUG_WARNING  +
DEBUG_WARNING  A non-critical error which might be useful for debugging.
UNSPECIFIED  +
UNSPECIFIED  The default, unspecified error type.
NO_DEVICES_FOUND  +
NO_DEVICES_FOUND  No devices found on system.
INVALID_DEVICE  +
INVALID_DEVICE  An invalid device ID was specified.
INVALID_STREAM  +
INVALID_STREAM  An invalid stream ID was specified.
MEMORY_ERROR  +
MEMORY_ERROR  An error occured during memory allocation.
INVALID_PARAMETER  +
INVALID_PARAMETER  An invalid parameter was specified to a function.
DRIVER_ERROR  +
DRIVER_ERROR  A system driver error occured.
SYSTEM_ERROR  +
SYSTEM_ERROR  A system error occured.
THREAD_ERROR  +
THREAD_ERROR  A thread error occured.
@@ -121,7 +122,7 @@ A thread error occured.
-
©2001-2004 Gary P. Scavone, McGill University. All Rights Reserved.
+
©2001-2005 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone, gary@music.mcgill.ca
-- cgit v1.2.3