Class: HeadMusic::Style::Annotation

Inherits:

Object

• Object
• HeadMusic::Style::Annotation

Defined in:

lib/head_music/style/annotation.rb

Overview

An Annotation encapsulates an issue with or comment on a voice

Direct Known Subclasses

Guidelines::AlwaysMove, Guidelines::ApproachPerfectionContrarily, Guidelines::AtLeastEightNotes, Guidelines::AvoidCrossingVoices, Guidelines::AvoidOverlappingVoices, Guidelines::ConsonantClimax, Guidelines::ConsonantDownbeats, Guidelines::Diatonic, Guidelines::DirectionChanges, Guidelines::EndOnPerfectConsonance, Guidelines::EndOnTonic, Guidelines::LimitOctaveLeaps, Guidelines::MostlyConjunct, Guidelines::NoRests, Guidelines::NoUnisonsInMiddle, Guidelines::NotesSameLength, Guidelines::OneToOne, Guidelines::PreferContraryMotion, Guidelines::PreferImperfect, Guidelines::PrepareOctaveLeaps, Guidelines::RecoverLargeLeaps, Guidelines::SingableIntervals, Guidelines::SingableRange, Guidelines::StartOnPerfectConsonance, Guidelines::StartOnTonic, Guidelines::StepDownToFinalNote, Guidelines::StepOutOfUnison, Guidelines::StepToFinalNote, Guidelines::StepUpToFinalNote, Guidelines::UpToFourteenNotes

Constant Summary

MESSAGE =

"Write music."

Instance Attribute Summary

• #voice ⇒ Object readonly

  Returns the value of attribute voice.

Instance Method Summary

• #adherent? ⇒ Boolean
• #end_position ⇒ Object
• #fitness ⇒ Object
• #initialize(voice) ⇒ Annotation constructor

  A new instance of Annotation.

• #message ⇒ Object
• #notes? ⇒ Boolean
• #start_position ⇒ Object

Constructor Details

#initialize(voice) ⇒ Annotation

Returns a new instance of Annotation.

# File 'lib/head_music/style/annotation.rb', line 27

def initialize(voice)
  @voice = voice
end

Instance Attribute Details

#voice ⇒ Object (readonly)

Returns the value of attribute voice.

# File 'lib/head_music/style/annotation.rb', line 7

def voice
  @voice
end

Instance Method Details

#adherent? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/head_music/style/annotation.rb', line 35

def adherent?
  fitness == 1
end

#end_position ⇒ Object

# File 'lib/head_music/style/annotation.rb', line 47

def end_position
  [marks].flatten.compact.map(&:end_position).max
end

#fitness ⇒ Object

# File 'lib/head_music/style/annotation.rb', line 31

def fitness
  [marks].flatten.compact.map(&:fitness).reduce(1, :*)
end

#message ⇒ Object

# File 'lib/head_music/style/annotation.rb', line 51

def message
  self.class::MESSAGE
end

#notes? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/head_music/style/annotation.rb', line 39

def notes?
  first_note
end

#start_position ⇒ Object

# File 'lib/head_music/style/annotation.rb', line 43

def start_position
  [marks].flatten.compact.map(&:start_position).min
end