org.audiveris.proxymusic

Class Cancel

java.lang.Object

org.audiveris.proxymusic.Cancel

public class Cancel
extends Object

A cancel element indicates that the old key signature should be cancelled before the new one appears. This will always happen when changing to C major or A minor and need not be specified then. The cancel value matches the fifths value of the cancelled key signature (e.g., a cancel of -2 will provide an explicit cancellation for changing from B flat major to F major). The optional location attribute indicates whether the cancellation appears relative to the new key signature.

Java class for cancel complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="cancel">
   <simpleContent>
     <extension base="<>fifths">
       <attribute name="location" type="{}cancel-location" />
     </extension>
   </simpleContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected CancelLocation	location
protected BigInteger	value

Constructor Summary

Constructors

Constructor and Description
Cancel()

Method Summary

Modifier and Type	Method and Description
CancelLocation	getLocation() Gets the value of the location property.
BigInteger	getValue() The fifths type represents the number of flats or sharps in a traditional key signature.
void	setLocation(CancelLocation value) Sets the value of the location property.
void	setValue(BigInteger value) Sets the value of the value property.

Methods inherited from class java.lang.Object

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

Field Detail

value

protected BigInteger value

location

protected CancelLocation location

Constructor Detail

Cancel

public Cancel()

Method Detail

getValue

public BigInteger getValue()

The fifths type represents the number of flats or sharps in a traditional key signature. Negative numbers are used for flats and positive numbers for sharps, reflecting the key's placement within the circle of fifths (hence the type name).

Returns:

possible object is BigInteger

setValue

public void setValue(BigInteger value)

Sets the value of the value property.

Parameters:

value - allowed object is BigInteger

getLocation

public CancelLocation getLocation()

Gets the value of the location property.

Returns:

possible object is CancelLocation

setLocation

public void setLocation(CancelLocation value)

Sets the value of the location property.

Parameters:

value - allowed object is CancelLocation