pl-nk v0.4.5
Plonk|Plink|Plank are a set of cross-platform C/C++ frameworks for audio software development
Static Public Member Functions
TypeCode Class Reference

Used to determine information about some types. More...

List of all members.

Static Public Member Functions

static plonk::Text getName (const int code) throw ()
 Returns a type code as a text string.
static plonk::LongLong getPeak (const int code) throw ()
 Used for sample types to determine the minimum / maximum peaks.
static double getEpsilon (const int code) throw ()
 Used for sample types to determine the smallest non-zero value.

Detailed Description

Used to determine information about some types.

Especially used to determine information about sample buffer types and the Dynamic class uses it to identify which type it currently stores. This doesn't catalogue all types, only the built-in types and those likely to be used as channel inputs (e.g., other units, busses, etc.)


Member Function Documentation

static double TypeCode::getEpsilon ( const int  code) throw () [inline, static]

Used for sample types to determine the smallest non-zero value.

For integers this is always 1 so is most useful for floating point types.

static plonk::Text TypeCode::getName ( const int  code) throw () [inline, static]

Returns a type code as a text string.

static plonk::LongLong TypeCode::getPeak ( const int  code) throw () [inline, static]

Used for sample types to determine the minimum / maximum peaks.

Most types return 0 to indicate that this is not useful information.


The documentation for this class was generated from the following file:
 All Classes Functions Typedefs Enumerations Enumerator Properties