Logo Search packages:      
Sourcecode: csound version File versions  Download package

Stk Class Reference

#include <Stk.h>

Inheritance diagram for Stk:

Effect FileRead FileWrite Filter Function Generator Instrmnt Messager MidiFileIn Mutex Phonemes RtDuplex Skini Socket Sphere Thread Vector3D Voicer WvIn WvOut

List of all members.


Detailed Description

STK base class.

Nearly all STK classes inherit from this class. The global sample rate and rawwave path variables can be queried and modified via Stk. In addition, this class provides error handling and byte-swapping functions.

by Perry R. Cook and Gary P. Scavone, 1995 - 2005.

Nearly all STK classes inherit from this class. The global sample rate can be queried and modified via Stk. In addition, this class provides error handling and byte-swapping functions.

by Perry R. Cook and Gary P. Scavone, 1995 - 2005.

Definition at line 94 of file Stk.h.


Public Types

typedef unsigned long StkFormat

Static Public Member Functions

static void handleError (std::string message, StkError::Type type)
 Static function for error reporting and handling using c++ strings.
static void handleError (const char *message, StkError::Type type)
 Static function for error reporting and handling using c-strings.
static void printErrors (bool status)
 Toggle display of error messages before throwing exceptions.
static std::string rawwavePath (void)
 Static method which returns the current rawwave path.
static StkFloat sampleRate (void)
 Static method which returns the current STK sample rate.
static void setRawwavePath (std::string path)
 Static method which sets the STK rawwave path.
static void setSampleRate (StkFloat rate)
 Static method which sets the STK sample rate.
static void showWarnings (bool status)
 Toggle display of WARNING and STATUS messages.
static void sleep (unsigned long milliseconds)
 Static cross-platform method to sleep for a number of milliseconds.
static void swap16 (unsigned char *ptr)
 Static method which byte-swaps a 16-bit data type.
static void swap32 (unsigned char *ptr)
 Static method which byte-swaps a 32-bit data type.
static void swap64 (unsigned char *ptr)
 Static method which byte-swaps a 64-bit data type.

Static Public Attributes

static const StkFormat STK_FLOAT32 = 0x10
static const StkFormat STK_FLOAT64 = 0x20
static const StkFormat STK_SINT16 = 0x2
static const StkFormat STK_SINT24 = 0x4
static const StkFormat STK_SINT32 = 0x8
static const StkFormat STK_SINT8 = 0x1

Protected Member Functions

void handleError (StkError::Type type)
 Internal function for error reporting which assumes message in errorString_ variable.
 Stk (void)
 Default constructor.
virtual ~Stk (void)
 Class destructor.

Protected Attributes

std::ostringstream errorString_

Static Private Attributes

static bool printErrors_ = true
static std::string rawwavepath_ = RAWWAVE_PATH
static bool showWarnings_ = false
static StkFloat srate_ = (StkFloat) SRATE

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index