From f58f7c5aafe9b52acf26fad31ac2c01c6a184fbc Mon Sep 17 00:00:00 2001 From: Gary Scavone Date: Thu, 10 Oct 2013 23:57:51 +0200 Subject: Release 2.1 tarball --- doc/html/classRtError.html | 370 ++++++--------------------------------------- 1 file changed, 50 insertions(+), 320 deletions(-) (limited to 'doc/html/classRtError.html') diff --git a/doc/html/classRtError.html b/doc/html/classRtError.html index 1f59ff7..b81582a 100644 --- a/doc/html/classRtError.html +++ b/doc/html/classRtError.html @@ -1,337 +1,67 @@ - - -The RtAudio Tutorial - - - -
-Tutorial   Class/Enum List   File List   Compound Members  
+ + +The RtAudio Tutorial + + + +
+Tutorial   Class/Enum List   File List   Compound Members  
-

RtError Class Reference

#include <RtAudio.h> +

RtError Class Reference

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

+#include <RtAudio.h>

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

Public Types

enum  TYPE {
-  WARNING, -DEBUG_WARNING, -UNSPECIFIED, -NO_DEVICES_FOUND, +  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. More...

virtual ~RtError (void)
 The destructor. More...

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

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

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


Protected Attributes

char error_message [256]
TYPE type
-

Member Enumeration Documentation

-

- - - - -
- - - - - -
-enum RtError::TYPE -
-
- - - - - -
-   - - -

-

-Enumeration values:
- - - - - - - - - - - - -
WARNING -  -
DEBUG_WARNING -  -
UNSPECIFIED -  -
NO_DEVICES_FOUND -  -
INVALID_DEVICE -  -
INVALID_STREAM -  -
MEMORY_ERROR -  -
INVALID_PARAMETER -  -
DRIVER_ERROR -  -
SYSTEM_ERROR -  -
THREAD_ERROR -  -
-
-
-

Constructor & Destructor Documentation

-

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

-The constructor. -

-

-

- - - - -
- - - - - - -
-RtError::~RtError ( - -void ) [virtual] -
-
- - - - - -
-   - - -

-The destructor. -

-

-

Member Function Documentation

-

- - - - -
- - - - - - -
-void RtError::printMessage ( - -void ) [virtual] -
-
- - - - + + + + + + + + + +
-   - - -

-Prints "thrown" error message to stdout. +

+ 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.

+

Detailed Description

+Exception handling class for RtAudio.

- - - -

- - - - -
- - - - - - -
-const TYPE & RtError::getType ( - -void ) [inline, virtual] -
-
- - - - - -
-   - - -

-Returns the "thrown" error message TYPE. -

-

-

- - - - -
- - - - - - -
-const char * RtError::getMessage ( - -void ) [inline, virtual] -
-
- - - - - -
-   - - -

-Returns the "thrown" error message string. -

-

-

Member Data Documentation

-

- - - - -
- - - - - -
-char RtError::error_message [protected] -
-
- - - - - -
-   - - +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 documentation for this class was generated from the following file: +
-
-TYPE RtError::type [protected] -
-
+ ©2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.
+ Maintained by Gary P. Scavone, gary@ccrma.stanford.edu

- - - - - -
-   - -

-

-

The documentation for this class was generated from the following file: -
- -
- ©2001-2002 CCRMA, Stanford University. All Rights Reserved.
- Maintained by Gary P. Scavone, gary@ccrma.stanford.edu

-

- - + -- cgit v1.2.3