From 2ea2d92e3b4e1e87ffe1df14da877334834a499f Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Fri, 11 Oct 2013 02:06:28 +0200 Subject: Release 4.0.12 tarball --- doc/html/classRtError.html | 119 +++++++++++++++++++++++++-------------------- 1 file changed, 67 insertions(+), 52 deletions(-) (limited to 'doc/html/classRtError.html') diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html index c98abd7..e564d86 100644 --- a/doc/html/classRtError.html +++ b/doc/html/classRtError.html @@ -8,60 +8,78 @@
Home   Class/Enum List   File List   Compound Members  
- + + +
+
+Public Types | +Public Member Functions | +List of all members
+
+
RtError Class Reference
+
-

RtError Class Reference

+

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

+ More...

#include <RtError.h>

-

List of all members.

- - -

Public Types

enum  Type {
-  WARNING, +

Inherits exception.

+ + + - - - - - - - - - - - - - - + + +

+Public Types

enum  Type {
+  WARNING, DEBUG_WARNING, UNSPECIFIED, NO_DEVICES_FOUND,
-  INVALID_DEVICE, +  INVALID_DEVICE, MEMORY_ERROR, INVALID_PARAMETER, INVALID_USE,
-  DRIVER_ERROR, +  DRIVER_ERROR, SYSTEM_ERROR, THREAD_ERROR
}
 

Defined RtError types.

- More...

Public Member Functions

- RtError (const std::string &message, Type type=RtError::UNSPECIFIED) throw ()
 The constructor.
-virtual ~RtError (void) throw ()
 The destructor.
-virtual void printMessage (void) const throw ()
 Prints thrown error message to stderr.
-virtual const Type & getType (void) const throw ()
 Returns the thrown error message type.
-virtual const std::string & getMessage (void) const throw ()
 Returns the thrown error message string.
-virtual const char * what (void) const throw ()
 Returns the thrown error message as a c-style string.
 Defined RtError types. More...
 
+ + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ RtError (const std::string &message, Type type=RtError::UNSPECIFIED) throw ()
 The constructor.
 
+virtual ~RtError (void) throw ()
 The destructor.
 
+virtual void printMessage (void) const throw ()
 Prints thrown error message to stderr.
 
+virtual const Type & getType (void) const throw ()
 Returns the thrown error message type.
 
+virtual const std::string & getMessage (void) const throw ()
 Returns the thrown error message string.
 
+virtual const char * what (void) const throw ()
 Returns the thrown error message as a c-style string.
 
-

Detailed Description

-

Exception handling class for RtAudio & RtMidi.

+

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.

-

Member Enumeration Documentation

- +

Member Enumeration Documentation

+
@@ -69,42 +87,41 @@ virtual const char * 
enum RtError::Type
-
-
+

Defined RtError types.

Enumerator:
- - - - - - - - - - -
WARNING  +
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.

MEMORY_ERROR  +
MEMORY_ERROR 

An error occured during memory allocation.

INVALID_PARAMETER  +
INVALID_PARAMETER 

An invalid parameter was specified to a function.

INVALID_USE  +
INVALID_USE 

The function was called incorrectly.

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.

@@ -116,12 +133,10 @@ virtual const char * 
The documentation for this class was generated from the following file: - +
- - +
©2001-2012 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone.
©2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone.
- -- cgit v1.2.3