Package eu.bandm.music.entities

Class Clef

java.lang.Object

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

eu.bandm.music.entities.Clef

All Implemented Interfaces:

Translet.Parseable<Clef>

public class Clef
extends Entity<Clef>

Realizes the clefs which indicate line-to-pitch reference point. These are currently (in English and German name) the "c", "f" and "g" clefs. Each one is related to some absolute pitch (white key, namely "c'", "klein-f"/"f-small" and "g'".
Later further keys NOT indicating pitch ("percussionkeys") may be added !?!?
The instantiation/positioning of a Clef is modelled by a ClefUsage.

Field Summary

Fields

Modifier and Type	Field	Description
static final Clef	c	The c clef, indicating "c-1".
static final EntityCatalog<Clef>	catalog	The catalog holding the three standard clefs for f,c and g.
static final Clef	f	The f clef, indicating "klein-f".
static final Clef	g	The g clef, indicating "g-1".
final FunctionalPitch	reference	The pitch which is indicated by placement of the graphical hot spot of the key symbol.

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

documentations

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Clef(EntityCatalog<Clef> catalog, FunctionalPitch reference, Map<String,String> names)	Only constructor, setting all parameters.

Method Summary

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

catalog

public static final EntityCatalog<Clef> catalog

The catalog holding the three standard clefs for f,c and g.

reference

public final FunctionalPitch reference

The pitch which is indicated by placement of the graphical hot spot of the key symbol.

f

public static final Clef f

The f clef, indicating "klein-f".

c

public static final Clef c

The c clef, indicating "c-1".

g

public static final Clef g

The g clef, indicating "g-1".

Constructor Details

Clef

protected Clef(EntityCatalog<Clef> catalog,
 FunctionalPitch reference,
 Map<String,String> names)

Only constructor, setting all parameters.