From be2eb99b37cd017fcab00c1704f794cb1bc85ee1 Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Fri, 11 Oct 2013 01:58:40 +0200 Subject: Release 4.0.7 tarball --- doc/html/classRtError.html | 181 +++++++++++++++++++++++---------------------- 1 file changed, 92 insertions(+), 89 deletions(-) (limited to 'doc/html/classRtError.html') diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html index e90dcf1..29fd564 100644 --- a/doc/html/classRtError.html +++ b/doc/html/classRtError.html @@ -8,116 +8,119 @@
Home   Class/Enum List   File List   Compound Members  
- +
-

RtError Class Reference

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

-#include <RtError.h> -

+

RtError Class Reference

+

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

-

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

#include <RtError.h>

- - - - - - - +

List of all members.

+

Public Types

enum  Type {
-  WARNING, -DEBUG_WARNING, -UNSPECIFIED, -NO_DEVICES_FOUND, -
-  INVALID_DEVICE, -MEMORY_ERROR, -INVALID_PARAMETER, -INVALID_USE, -
-  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) throw ()
 Prints thrown error message to stderr.
-virtual const Type & getType (void) throw ()
 Returns the thrown error message type.
-virtual const std::string & getMessage (void) throw ()
 Returns the thrown error message string.
-virtual const char * what (void) const throw ()
 Returns the thrown error message as a c-style string.
+ + + + + + + + + + + + + + + +

Public Types

enum  Type {
+  WARNING, +DEBUG_WARNING, +UNSPECIFIED, +NO_DEVICES_FOUND, +
+  INVALID_DEVICE, +MEMORY_ERROR, +INVALID_PARAMETER, +INVALID_USE, +
+  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) throw ()
 Prints thrown error message to stderr.
+virtual const Type & getType (void) throw ()
 Returns the thrown error message type.
+virtual const std::string & getMessage (void) 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. -

-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

- +

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

+
- +
enum RtError::Type enum RtError::Type
-

-Defined RtError types. -

-

Enumerator:
- - - - - - - - - - - - +

Defined RtError types.

+
Enumerator:
WARNING  -A non-critical error.
DEBUG_WARNING  -A non-critical error which might be useful for debugging.
UNSPECIFIED  -The default, unspecified error type.
NO_DEVICES_FOUND  -No devices found on system.
INVALID_DEVICE  -An invalid device ID was specified.
MEMORY_ERROR  -An error occured during memory allocation.
INVALID_PARAMETER  -An invalid parameter was specified to a function.
INVALID_USE  -The function was called incorrectly.
DRIVER_ERROR  -A system driver error occured.
SYSTEM_ERROR  -A system error occured.
THREAD_ERROR  -A thread error occured.
+ + + + + + + + + + +
WARNING  +

A non-critical error.

+
DEBUG_WARNING  +

A non-critical error which might be useful for debugging.

+
UNSPECIFIED  +

The default, unspecified error type.

+
NO_DEVICES_FOUND  +

No devices found on system.

+
INVALID_DEVICE  +

An invalid device ID was specified.

+
MEMORY_ERROR  +

An error occured during memory allocation.

+
INVALID_PARAMETER  +

An invalid parameter was specified to a function.

+
INVALID_USE  +

The function was called incorrectly.

+
DRIVER_ERROR  +

A system driver error occured.

+
SYSTEM_ERROR  +

A system error occured.

+
THREAD_ERROR  +

A thread error occured.

+
+
-

-

The documentation for this class was generated from the following file: +
+
The documentation for this class was generated from the following file:
- +
©2001-2009 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone.
©2001-2010 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone.
-- cgit v1.2.3