Package eu.bandm.music.entities

Class WhiteKeyModOctave

java.lang.Object

eu.bandm.tscore.base.Entity<E>

eu.bandm.music.entities.PitchModOctave<WhiteKeyModOctave>

eu.bandm.music.entities.WhiteKeyModOctave

All Implemented Interfaces:

PitchIndication, Translet.Parseable<WhiteKeyModOctave>

public class WhiteKeyModOctave
extends PitchModOctave<WhiteKeyModOctave>

A specialization of PitchModOctave which represents only the "white keys" of the keyboard. By adding alterations, one gets FunctionalPitchModOctave.

Field Summary

Fields

Modifier and Type	Field	Description
static final WhiteKeyModOctave	a	The white key called "a".
static final WhiteKeyModOctave	b_h	The white key called "b" in English and "h" in German.
static final WhiteKeyModOctave	c	The white key called "c".
static final EntityCatalog<WhiteKeyModOctave>	catalog	The catalog holding the constant values of this type.
static final WhiteKeyModOctave	d	The white key called "d".
static final WhiteKeyModOctave	e	The white key called "e".
static final WhiteKeyModOctave	f	The white key called "f".
protected final int	fifthsFromC	Distance of this pitch class from the c, measured in fifth upwards.
static final WhiteKeyModOctave	g	The white key called "g".
static final int	halfTones_per_Fifth	Number of half tone steps on the keyboard which correspond to the interval of a fifth.
static final int	halfTones_per_Octave	Number of half tone steps on the keyboard which correspond to the interval of an octave.
protected final int	halfTonesFromC	Distance of this pitch class from the c, measured in half tone steps upwards.
static final WhiteKeyModOctave[]	whiteKeyScale	The ascending scale of white keys starting with c.
protected final int	whiteKeysFromC	Distance of this pitch class from the c, measured in white keys upwards.

Fields inherited from class eu.bandm.tscore.base.Entity

documentations

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WhiteKeyModOctave(int whiteKeysFromC, int fifthsFromC, EntityCatalog<WhiteKeyModOctave> catalog, Map<String,String> map)	Only constructor, setting all parameters.

Method Summary

Modifier and Type	Method	Description
int	get_fifthsFromC()	Get positive distance from c up to this pitch, in fifth.
int	get_halfTonesFromC()	Get positive distance from c up to this pitch, in half tones / chromatic steps.
int	get_whiteKeysFromC()	Get positive distance from c up to this pitch, in white keys / scalar steps.
static WhiteKeyModOctave	getWhiteKeyFromC(int i)	Get the white key which lays the given number of steps above c, modulo 7.

Methods inherited from class eu.bandm.tscore.base.Entity

addName, dump, dump, getCatalog, getDocumentation, getDocumentation, getDocumentations, getName, getName, getNames, getParser, getParser, setDocumentation, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

halfTones_per_Fifth

public static final int halfTones_per_Fifth

Number of half tone steps on the keyboard which correspond to the interval of a fifth.

See Also:

• Constant Field Values

halfTones_per_Octave

public static final int halfTones_per_Octave

Number of half tone steps on the keyboard which correspond to the interval of an octave.

See Also:

• Constant Field Values

whiteKeysFromC

protected final int whiteKeysFromC

Distance of this pitch class from the c, measured in white keys upwards.

halfTonesFromC

protected final int halfTonesFromC

Distance of this pitch class from the c, measured in half tone steps upwards.

fifthsFromC

protected final int fifthsFromC

Distance of this pitch class from the c, measured in fifth upwards.

catalog

public static final EntityCatalog<WhiteKeyModOctave> catalog

The catalog holding the constant values of this type.

c

public static final WhiteKeyModOctave c

The white key called "c".

d

public static final WhiteKeyModOctave d

The white key called "d".

e

public static final WhiteKeyModOctave e

The white key called "e".

f

public static final WhiteKeyModOctave f

The white key called "f".

g

public static final WhiteKeyModOctave g

The white key called "g".

a

public static final WhiteKeyModOctave a

The white key called "a".

b_h

public static final WhiteKeyModOctave b_h

The white key called "b" in English and "h" in German.

whiteKeyScale

public static final WhiteKeyModOctave[] whiteKeyScale

The ascending scale of white keys starting with c.

Constructor Details

WhiteKeyModOctave

protected WhiteKeyModOctave(int whiteKeysFromC,
 int fifthsFromC,
 EntityCatalog<WhiteKeyModOctave> catalog,
 Map<String,String> map)

Only constructor, setting all parameters.

Method Details

get_whiteKeysFromC

public int get_whiteKeysFromC()

Get positive distance from c up to this pitch, in white keys / scalar steps.

get_halfTonesFromC

public int get_halfTonesFromC()

Get positive distance from c up to this pitch, in half tones / chromatic steps.

get_fifthsFromC

public int get_fifthsFromC()

Get positive distance from c up to this pitch, in fifth.

getWhiteKeyFromC

public static WhiteKeyModOctave getWhiteKeyFromC(int i)

Get the white key which lays the given number of steps above c, modulo 7. If i<0 find the white key the given number below.