From 830706e4368bb27d4c7d8138fbce4e393cedcd2f Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Fri, 11 Oct 2013 00:00:56 +0200 Subject: Release 3.0 tarball --- doc/html/classRtError.html | 138 ++++++++++++++++++++++++++++++++------------- 1 file changed, 100 insertions(+), 38 deletions(-) (limited to 'doc/html/classRtError.html') diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html index b81582a..7301c2c 100644 --- a/doc/html/classRtError.html +++ b/doc/html/classRtError.html @@ -7,60 +7,122 @@
Tutorial   Class/Enum List   File List   Compound Members  
- -

RtError Class Reference

Exception handling class for RtAudio. + +

RtError Class Reference

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

-#include <RtAudio.h> +#include <RtError.h>

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

Public Types

enum  TYPE {
-  WARNING, -DEBUG_WARNING, -UNSPECIFIED, -NO_DEVICES_FOUND, +
enum  Type {
+  WARNING, +DEBUG_WARNING, +UNSPECIFIED, +NO_DEVICES_FOUND,
-  INVALID_DEVICE, -INVALID_STREAM, -MEMORY_ERROR, -INVALID_PARAMETER, +  INVALID_DEVICE, +INVALID_STREAM, +MEMORY_ERROR, +INVALID_PARAMETER,
-  DRIVER_ERROR, -SYSTEM_ERROR, -THREAD_ERROR +  DRIVER_ERROR, +SYSTEM_ERROR, +THREAD_ERROR
}
 Defined RtError types.


Public Methods

- RtError (const char *p, TYPE tipe=RtError::UNSPECIFIED)
 The constructor.

-virtual ~RtError (void)
 The destructor.

-virtual void printMessage (void)
 Prints "thrown" error message to stdout.

-virtual const TYPE& getType (void)
 Returns the "thrown" error message TYPE.

-virtual const char* getMessage (void)
 Returns the "thrown" error message string.

 Defined RtError types. More...


Public Member Functions

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

+virtual ~RtError (void)
 The destructor.

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

+virtual const Type & getType (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 as a C string.

Detailed Description

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

-The RtError class is quite simple but it does allow errors to be "caught" by RtError::TYPE. Almost all RtAudio methods can "throw" an RtError, most typically if an invalid stream identifier is supplied to a method or a driver error occurs. There are a number of cases within RtAudio where warning messages may be displayed but an exception is not thrown. There is a private RtAudio method, error(), which can be modified to globally control how these messages are handled and reported. +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 +
+
+ + + + + +
+   + + +

+Defined RtError types. +

+

Enumeration values:
+ + + + + + + + + + + + +
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.
INVALID_STREAM  +An invalid stream ID was specified.
MEMORY_ERROR  +An error occured during memory allocation.
INVALID_PARAMETER  +An invalid parameter was specified to a function.
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: +
  • RtError.h
    -
    - ©2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.
    - Maintained by Gary P. Scavone, gary@ccrma.stanford.edu

    + +
    ©2001-2004 Gary P. Scavone, McGill University. All Rights Reserved.
    + Maintained by Gary P. Scavone, gary@music.mcgill.ca
    -- cgit v1.2.3