Tutorial   Class/Enum List   File List   Compound Members  

RtError Class Reference

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

#include <RtError.h>

List of all members.

Public Types

enum  Type {
  WARNING, DEBUG_WARNING, UNSPECIFIED, NO_DEVICES_FOUND,
  INVALID_DEVICE, INVALID_STREAM, MEMORY_ERROR, INVALID_PARAMETER,
  DRIVER_ERROR, SYSTEM_ERROR, THREAD_ERROR
}
 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 & 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
 

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.
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:
©2001-2005 Gary P. Scavone, McGill University. All Rights Reserved.
Maintained by Gary P. Scavone, gary@music.mcgill.ca