Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

TSE3::KeySig Class Reference

A key signature change. More...

#include <KeySigTrack.h>

List of all members.

Public Types

enum  KeySigIncidentals {
  Cb = -7, Gb = -6, Db = -5, Ab = -4,
  Eb = -3, Bb = -2, F = -1, C = 0,
  G = 1, D = 2, A = 3, E = 4,
  B = 5, Fs = 6, Cs = 7
}
enum  KeySigIncidentalsMinor {
  Abm = -7, Fbbm = -6, Bbm = -5, Gbm = -4,
  Cm = -3, Dm = -2, Fm = -1, Am = 0,
  Em = 1, Bm = 2, Fsm = 3, Csm = 4,
  Gsm = 5, Dsm = 6, Asm = 7
}
enum  KeySigType { Major = 0, Minor = 1 }

Public Member Functions

 KeySig (int incidentals=C, int type=Major)
int operator== (const KeySig &k) const

Public Attributes

int incidentals
int type


Detailed Description

A key signature change.

KeySig objects are values of key signature change that occur in the Song, held in the KeySigTrack.

This class defines the type that is used to create KeySig events, which are of type Event<KeySig>.

When streamed from a Playable interface (using the class) KeySig objects are represented by a MidiEvent containing a MidiCommand_TSE_Meta MidiCommand with data 1 byte as MidiCommand_TSE_Meta_KeySig.

KeySig is a value type.

Author:
Pete Goodliffe
Version:
3.00
See also:
KeySigTrack

Event


Member Enumeration Documentation

enum TSE3::KeySig::KeySigIncidentals
 

This enum type describes the number of incidentals in a key, this will determine it as one of a pair of major/minor keys. The KeySigType enum resolves exactly which key is represented.

Negative values for this type represent the number of flats in the key. Positive values represent the number of sharps in the key.

Since the names are major ones (for all the difference that makes) you can use the KeySigIncidentalsMinor to specify minor names. Remember that this name means nothing, whether the key is minor or major is determined by the KeySigType value alone.

See also:
KeySigType

KeySigIncidentalsMinor

Enumeration values:
Cb 
Gb 
Db 
Ab 
Eb 
Bb 
F 
C 
G 
D 
A 
E 
B 
Fs 
Cs 

enum TSE3::KeySig::KeySigIncidentalsMinor
 

Minor version of the KeySigIncidentals enum type.

See also:
KeySigIncidentals
Enumeration values:
Abm 
Fbbm 
Bbm 
Gbm 
Cm 
Dm 
Fm 
Am 
Em 
Bm 
Fsm 
Csm 
Gsm 
Dsm 
Asm 

enum TSE3::KeySig::KeySigType
 

Represents whether a key is major or minor.

Values are:

  • Major Represents a major key
  • Minor Represents a minor key
See also:
KeySigIncidentals
Enumeration values:
Major 
Minor 


Constructor & Destructor Documentation

TSE3::KeySig::KeySig int  incidentals = C,
int  type = Major
[inline]
 

Create a KeySig.

Parameters:
incidentals No sharps/flats in key
type Whether it is a major/minor key


Member Function Documentation

int TSE3::KeySig::operator== const KeySig k  )  const [inline]
 


Member Data Documentation

int TSE3::KeySig::incidentals
 

The number of incidentals (sharps/flats) in this key signature.

int TSE3::KeySig::type
 

The type of this key signature (major/minor).


The documentation for this class was generated from the following file:
Generated on Wed May 25 14:46:14 2005 for TSE3 by doxygen 1.3.2