Harmonic (ProxyMusic 3.0.1 API)

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

public class Harmonic
extends Object

The harmonic type indicates natural and artificial harmonics. Allowing the type of pitch to be specified, combined with controls for appearance/playback differences, allows both the notation and the sound to be represented. Artificial harmonics can add a notated touching-pitch; artificial pinch harmonics will usually not notate a touching pitch. The attributes for the harmonic element refer to the use of the circular harmonic symbol, typically but not always used with natural harmonics.

Java class for harmonic complex type.

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

 <complexType name="harmonic">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <choice minOccurs="0">
           <element name="natural" type="{}empty"/>
           <element name="artificial" type="{}empty"/>
         </choice>
         <choice minOccurs="0">
           <element name="base-pitch" type="{}empty"/>
           <element name="touching-pitch" type="{}empty"/>
           <element name="sounding-pitch" type="{}empty"/>
         </choice>
       </sequence>
       <attGroup ref="{}print-style"/>
       <attGroup ref="{}print-object"/>
       <attGroup ref="{}placement"/>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Empty`	`artificial`
`protected Empty`	`basePitch`
`protected String`	`color`
`protected BigDecimal`	`defaultX`
`protected BigDecimal`	`defaultY`
`protected String`	`fontFamily`
`protected String`	`fontSize`
`protected FontStyle`	`fontStyle`
`protected FontWeight`	`fontWeight`
`protected Empty`	`natural`
`protected AboveBelow`	`placement`
`protected YesNo`	`printObject`
`protected BigDecimal`	`relativeX`
`protected BigDecimal`	`relativeY`
`protected Empty`	`soundingPitch`
`protected Empty`	`touchingPitch`

Constructor Summary

Constructors
Constructor and Description

Harmonic()

Constructors
Constructor and Description
`Harmonic()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Empty`	`getArtificial()` Gets the value of the artificial property.
`Empty`	`getBasePitch()` Gets the value of the basePitch property.
`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.
`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.
`Empty`	`getNatural()` Gets the value of the natural property.
`AboveBelow`	`getPlacement()` Gets the value of the placement property.
`YesNo`	`getPrintObject()` Gets the value of the printObject property.
`BigDecimal`	`getRelativeX()` Gets the value of the relativeX property.
`BigDecimal`	`getRelativeY()` Gets the value of the relativeY property.
`Empty`	`getSoundingPitch()` Gets the value of the soundingPitch property.
`Empty`	`getTouchingPitch()` Gets the value of the touchingPitch property.
`void`	`setArtificial(Empty value)` Sets the value of the artificial property.
`void`	`setBasePitch(Empty value)` Sets the value of the basePitch 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`	`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`	`setNatural(Empty value)` Sets the value of the natural property.
`void`	`setPlacement(AboveBelow value)` Sets the value of the placement property.
`void`	`setPrintObject(YesNo value)` Sets the value of the printObject property.
`void`	`setRelativeX(BigDecimal value)` Sets the value of the relativeX property.
`void`	`setRelativeY(BigDecimal value)` Sets the value of the relativeY property.
`void`	`setSoundingPitch(Empty value)` Sets the value of the soundingPitch property.
`void`	`setTouchingPitch(Empty value)` Sets the value of the touchingPitch property.

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

- Field Detail
  - natural
```
protected Empty natural
```
  - artificial
```
protected Empty artificial
```
  - basePitch
```
protected Empty basePitch
```
  - touchingPitch
```
protected Empty touchingPitch
```
  - soundingPitch
```
protected Empty soundingPitch
```
  - 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
```
  - printObject
```
protected YesNo printObject
```
  - placement
```
protected AboveBelow placement
```
- Constructor Detail
  - Harmonic
```
public Harmonic()
```
- Method Detail
  - getNatural
```
public Empty getNatural()
```
    Gets the value of the natural property.
    
    Returns:
    
    possible object is Empty
  - setNatural
```
public void setNatural(Empty value)
```
    Sets the value of the natural property.
    
    Parameters:
    
    value - allowed object is Empty
  - getArtificial
```
public Empty getArtificial()
```
    Gets the value of the artificial property.
    
    Returns:
    
    possible object is Empty
  - setArtificial
```
public void setArtificial(Empty value)
```
    Sets the value of the artificial property.
    
    Parameters:
    
    value - allowed object is Empty
  - getBasePitch
```
public Empty getBasePitch()
```
    Gets the value of the basePitch property.
    
    Returns:
    
    possible object is Empty
  - setBasePitch
```
public void setBasePitch(Empty value)
```
    Sets the value of the basePitch property.
    
    Parameters:
    
    value - allowed object is Empty
  - getTouchingPitch
```
public Empty getTouchingPitch()
```
    Gets the value of the touchingPitch property.
    
    Returns:
    
    possible object is Empty
  - setTouchingPitch
```
public void setTouchingPitch(Empty value)
```
    Sets the value of the touchingPitch property.
    
    Parameters:
    
    value - allowed object is Empty
  - getSoundingPitch
```
public Empty getSoundingPitch()
```
    Gets the value of the soundingPitch property.
    
    Returns:
    
    possible object is Empty
  - setSoundingPitch
```
public void setSoundingPitch(Empty value)
```
    Sets the value of the soundingPitch property.
    
    Parameters:
    
    value - allowed object is Empty
  - 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
  - getPrintObject
```
public YesNo getPrintObject()
```
    Gets the value of the printObject property.
    
    Returns:
    
    possible object is YesNo
  - setPrintObject
```
public void setPrintObject(YesNo value)
```
    Sets the value of the printObject property.
    
    Parameters:
    
    value - allowed object is YesNo
  - 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

Class Harmonic

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

natural

artificial

basePitch

touchingPitch

soundingPitch

defaultX

defaultY

relativeX

relativeY

color

fontFamily

fontStyle

fontSize

fontWeight

printObject

placement

Constructor Detail

Harmonic

Method Detail

getNatural

setNatural

getArtificial

setArtificial

getBasePitch

setBasePitch

getTouchingPitch

setTouchingPitch

getSoundingPitch

setSoundingPitch

getDefaultX

setDefaultX

getDefaultY

setDefaultY

getRelativeX

setRelativeX

getRelativeY

setRelativeY

getColor

setColor

getFontFamily

setFontFamily

getFontStyle

setFontStyle

getFontSize

setFontSize

getFontWeight

setFontWeight

getPrintObject

setPrintObject

getPlacement

setPlacement