metdetection.time

Class KeySignature

java.lang.Object

metdetection.time.KeySignature

public class KeySignature
extends java.lang.Object

A KeySignature stores the key signature of a song. That is, the key (represented by the number of sharps in its signature), and whether it is major or minor.

Author:

Andrew McLeod - 11 Feb, 2015

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	major True if this key is major.
private int	numSharps The number of sharps in this key signature.

Constructor Summary

Constructors

Constructor and Description
KeySignature() Create a default key signature (C major).
KeySignature(byte[] data) Create a new Key Signature based on the given data array.
KeySignature(int keyNumber, boolean isMajor) Create a new key signature based on the given key number and major boolean.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
int	getNumSharps() Get the number of sharps in this key signature.
int	getPositiveOffsetFromC() Get the positive offset from C of the tonic note of this key.
int	hashCode()
boolean	isMajor() Return whether this key is major or not.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

numSharps

private final int numSharps

The number of sharps in this key signature. Negative numbers indicate the number of flats.

major

private final boolean major

True if this key is major. False for minor.

Constructor Detail

KeySignature

public KeySignature()

Create a default key signature (C major).

KeySignature

public KeySignature(byte[] data)

Create a new Key Signature based on the given data array.

Parameters:

data - data[0] is numSharps. data[1] is 0 for major, 1 for minor.

KeySignature

public KeySignature(int keyNumber,
            boolean isMajor)

Create a new key signature based on the given key number and major boolean.

Parameters:

keyNumber - The positive offset from c to this key's tonic note.

isMajor - major

Method Detail

getPositiveOffsetFromC

public int getPositiveOffsetFromC()

Get the positive offset from C of the tonic note of this key.

Returns:

The number of semitones between C and the next highest instance of the tonic of this key, on the range [0,11]

getNumSharps

public int getNumSharps()

Get the number of sharps in this key signature.

Returns:

numSharps

isMajor

public boolean isMajor()

Return whether this key is major or not.

Returns:

major

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object