Dynamics (ProxyMusic 3.0.1 API)

java.lang.Object
- org.audiveris.proxymusic.Dynamics

public class Dynamics
extends Object

Dynamics can be associated either with a note or a general musical direction. To avoid inconsistencies between and amongst the letter abbreviations for dynamics (what is sf vs. sfz, standing alone or with a trailing dynamic that is not always piano), we use the actual letters as the names of these dynamic elements. The other-dynamics element allows other dynamic marks that are not covered here, but many of those should perhaps be included in a more general musical direction element. Dynamics elements may also be combined to create marks not covered by a single element, such as sfmp. These letter dynamic symbols are separated from crescendo, decrescendo, and wedge indications. Dynamic representation is inconsistent in scores. Many things are assumed by the composer and left out, such as returns to original dynamics. Systematic representations are quite complex: for example, Humdrum has at least 3 representation formats related to dynamics. The MusicXML format captures what is in the score, but does not try to be optimal for analysis or synthesis of dynamics.

Java class for dynamics complex type.

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

 <complexType name="dynamics">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice maxOccurs="unbounded" minOccurs="0">
         <element name="p" type="{}empty"/>
         <element name="pp" type="{}empty"/>
         <element name="ppp" type="{}empty"/>
         <element name="pppp" type="{}empty"/>
         <element name="ppppp" type="{}empty"/>
         <element name="pppppp" type="{}empty"/>
         <element name="f" type="{}empty"/>
         <element name="ff" type="{}empty"/>
         <element name="fff" type="{}empty"/>
         <element name="ffff" type="{}empty"/>
         <element name="fffff" type="{}empty"/>
         <element name="ffffff" type="{}empty"/>
         <element name="mp" type="{}empty"/>
         <element name="mf" type="{}empty"/>
         <element name="sf" type="{}empty"/>
         <element name="sfp" type="{}empty"/>
         <element name="sfpp" type="{}empty"/>
         <element name="fp" type="{}empty"/>
         <element name="rf" type="{}empty"/>
         <element name="rfz" type="{}empty"/>
         <element name="sfz" type="{}empty"/>
         <element name="sffz" type="{}empty"/>
         <element name="fz" type="{}empty"/>
         <element name="other-dynamics" type="{http://www.w3.org/2001/XMLSchema}string"/>
       </choice>
       <attGroup ref="{}enclosure"/>
       <attGroup ref="{}placement"/>
       <attGroup ref="{}print-style-align"/>
       <attGroup ref="{}text-decoration"/>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`color`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected EnclosureShape`	`enclosure`
`protected String`	`fontFamily`
`protected String`	`fontSize`
`protected FontStyle`	`fontStyle`
`protected FontWeight`	`fontWeight`
`protected LeftCenterRight`	`halign`
`protected Integer`	`lineThrough`
`protected Integer`	`overline`
`protected AboveBelow`	`placement`
`protected List<JAXBElement<?>>`	`pOrPpOrPpp`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected Integer`	`underline`
`protected Valign`	`valign`

Constructor Summary

Constructors
Constructor and Description

Dynamics()

Constructors
Constructor and Description
`Dynamics()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getColor()` Gets the value of the color property.
`BigDecimal`	`getDefaultX()` Gets the value of the defaultX property.
`BigDecimal`	`getDefaultY()` Gets the value of the defaultY property.
`EnclosureShape`	`getEnclosure()` Gets the value of the enclosure property.
`String`	`getFontFamily()` Gets the value of the fontFamily property.
`String`	`getFontSize()` Gets the value of the fontSize property.
`FontStyle`	`getFontStyle()` Gets the value of the fontStyle property.
`FontWeight`	`getFontWeight()` Gets the value of the fontWeight property.
`LeftCenterRight`	`getHalign()` Gets the value of the halign property.
`Integer`	`getLineThrough()` Gets the value of the lineThrough property.
`Integer`	`getOverline()` Gets the value of the overline property.
`AboveBelow`	`getPlacement()` Gets the value of the placement property.
`List<JAXBElement<?>>`	`getPOrPpOrPpp()` Gets the value of the pOrPpOrPpp property.
`BigDecimal`	`getRelativeX()` Gets the value of the relativeX property.
`BigDecimal`	`getRelativeY()` Gets the value of the relativeY property.
`Integer`	`getUnderline()` Gets the value of the underline property.
`Valign`	`getValign()` Gets the value of the valign property.
`void`	`setColor(String value)` Sets the value of the color property.
`void`	`setDefaultX(BigDecimal value)` Sets the value of the defaultX property.
`void`	`setDefaultY(BigDecimal value)` Sets the value of the defaultY property.
`void`	`setEnclosure(EnclosureShape value)` Sets the value of the enclosure property.
`void`	`setFontFamily(String value)` Sets the value of the fontFamily property.
`void`	`setFontSize(String value)` Sets the value of the fontSize property.
`void`	`setFontStyle(FontStyle value)` Sets the value of the fontStyle property.
`void`	`setFontWeight(FontWeight value)` Sets the value of the fontWeight property.
`void`	`setHalign(LeftCenterRight value)` Sets the value of the halign property.
`void`	`setLineThrough(Integer value)` Sets the value of the lineThrough property.
`void`	`setOverline(Integer value)` Sets the value of the overline property.
`void`	`setPlacement(AboveBelow value)` Sets the value of the placement property.
`void`	`setRelativeX(BigDecimal value)` Sets the value of the relativeX property.
`void`	`setRelativeY(BigDecimal value)` Sets the value of the relativeY property.
`void`	`setUnderline(Integer value)` Sets the value of the underline property.
`void`	`setValign(Valign value)` Sets the value of the valign property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - pOrPpOrPpp
```
protected List<JAXBElement<?>> pOrPpOrPpp
```
  - enclosure
```
protected EnclosureShape enclosure
```
  - placement
```
protected AboveBelow placement
```
  - valign
```
protected Valign valign
```
  - halign
```
protected LeftCenterRight halign
```
  - defaultX
```
protected BigDecimal defaultX
```
  - defaultY
```
protected BigDecimal defaultY
```
  - relativeX
```
protected BigDecimal relativeX
```
  - relativeY
```
protected BigDecimal relativeY
```
  - color
```
protected String color
```
  - fontFamily
```
protected String fontFamily
```
  - fontStyle
```
protected FontStyle fontStyle
```
  - fontSize
```
protected String fontSize
```
  - fontWeight
```
protected FontWeight fontWeight
```
  - underline
```
protected Integer underline
```
  - overline
```
protected Integer overline
```
  - lineThrough
```
protected Integer lineThrough
```
- Constructor Detail
  - Dynamics
```
public Dynamics()
```
- Method Detail
  - getPOrPpOrPpp
```
public List<JAXBElement<?>> getPOrPpOrPpp()
```
    Gets the value of the pOrPpOrPpp property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the pOrPpOrPpp property.
    For example, to add a new item, do as follows:
```
    getPOrPpOrPpp().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<String> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty> JAXBElement<Empty>
  - getEnclosure
```
public EnclosureShape getEnclosure()
```
    Gets the value of the enclosure property.
    
    Returns:
    
    possible object is EnclosureShape
  - setEnclosure
```
public void setEnclosure(EnclosureShape value)
```
    Sets the value of the enclosure property.
    
    Parameters:
    
    value - allowed object is EnclosureShape
  - getPlacement
```
public AboveBelow getPlacement()
```
    Gets the value of the placement property.
    
    Returns:
    
    possible object is AboveBelow
  - setPlacement
```
public void setPlacement(AboveBelow value)
```
    Sets the value of the placement property.
    
    Parameters:
    
    value - allowed object is AboveBelow
  - getValign
```
public Valign getValign()
```
    Gets the value of the valign property.
    
    Returns:
    
    possible object is Valign
  - setValign
```
public void setValign(Valign value)
```
    Sets the value of the valign property.
    
    Parameters:
    
    value - allowed object is Valign
  - getHalign
```
public LeftCenterRight getHalign()
```
    Gets the value of the halign property.
    
    Returns:
    
    possible object is LeftCenterRight
  - setHalign
```
public void setHalign(LeftCenterRight value)
```
    Sets the value of the halign property.
    
    Parameters:
    
    value - allowed object is LeftCenterRight
  - getDefaultX
```
public BigDecimal getDefaultX()
```
    Gets the value of the defaultX property.
    
    Returns:
    
    possible object is BigDecimal
  - setDefaultX
```
public void setDefaultX(BigDecimal value)
```
    Sets the value of the defaultX property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getDefaultY
```
public BigDecimal getDefaultY()
```
    Gets the value of the defaultY property.
    
    Returns:
    
    possible object is BigDecimal
  - setDefaultY
```
public void setDefaultY(BigDecimal value)
```
    Sets the value of the defaultY property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getRelativeX
```
public BigDecimal getRelativeX()
```
    Gets the value of the relativeX property.
    
    Returns:
    
    possible object is BigDecimal
  - setRelativeX
```
public void setRelativeX(BigDecimal value)
```
    Sets the value of the relativeX property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getRelativeY
```
public BigDecimal getRelativeY()
```
    Gets the value of the relativeY property.
    
    Returns:
    
    possible object is BigDecimal
  - setRelativeY
```
public void setRelativeY(BigDecimal value)
```
    Sets the value of the relativeY property.
    
    Parameters:
    
    value - allowed object is BigDecimal
  - getColor
```
public String getColor()
```
    Gets the value of the color property.
    
    Returns:
    
    possible object is String
  - setColor
```
public void setColor(String value)
```
    Sets the value of the color property.
    
    Parameters:
    
    value - allowed object is String
  - getFontFamily
```
public String getFontFamily()
```
    Gets the value of the fontFamily property.
    
    Returns:
    
    possible object is String
  - setFontFamily
```
public void setFontFamily(String value)
```
    Sets the value of the fontFamily property.
    
    Parameters:
    
    value - allowed object is String
  - getFontStyle
```
public FontStyle getFontStyle()
```
    Gets the value of the fontStyle property.
    
    Returns:
    
    possible object is FontStyle
  - setFontStyle
```
public void setFontStyle(FontStyle value)
```
    Sets the value of the fontStyle property.
    
    Parameters:
    
    value - allowed object is FontStyle
  - getFontSize
```
public String getFontSize()
```
    Gets the value of the fontSize property.
    
    Returns:
    
    possible object is String
  - setFontSize
```
public void setFontSize(String value)
```
    Sets the value of the fontSize property.
    
    Parameters:
    
    value - allowed object is String
  - getFontWeight
```
public FontWeight getFontWeight()
```
    Gets the value of the fontWeight property.
    
    Returns:
    
    possible object is FontWeight
  - setFontWeight
```
public void setFontWeight(FontWeight value)
```
    Sets the value of the fontWeight property.
    
    Parameters:
    
    value - allowed object is FontWeight
  - getUnderline
```
public Integer getUnderline()
```
    Gets the value of the underline property.
    
    Returns:
    
    possible object is Integer
  - setUnderline
```
public void setUnderline(Integer value)
```
    Sets the value of the underline property.
    
    Parameters:
    
    value - allowed object is Integer
  - getOverline
```
public Integer getOverline()
```
    Gets the value of the overline property.
    
    Returns:
    
    possible object is Integer
  - setOverline
```
public void setOverline(Integer value)
```
    Sets the value of the overline property.
    
    Parameters:
    
    value - allowed object is Integer
  - getLineThrough
```
public Integer getLineThrough()
```
    Gets the value of the lineThrough property.
    
    Returns:
    
    possible object is Integer
  - setLineThrough
```
public void setLineThrough(Integer value)
```
    Sets the value of the lineThrough property.
    
    Parameters:
    
    value - allowed object is Integer

Class Dynamics

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pOrPpOrPpp

enclosure

placement

valign

halign

defaultX

defaultY

relativeX

relativeY

color

fontFamily

fontStyle

fontSize

fontWeight

underline

overline

lineThrough

Constructor Detail

Dynamics

Method Detail

getPOrPpOrPpp

getEnclosure

setEnclosure

getPlacement

setPlacement

getValign

setValign

getHalign

setHalign

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getColor

setColor

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFontWeight

setFontWeight

getUnderline

setUnderline

getOverline

setOverline

getLineThrough

setLineThrough