Class: Alda::AtMarker

Inherits:

Event

• Object
• Event
• Alda::AtMarker

Defined in:

lib/alda-rb/event.rb

Overview

An at-marker event. An Alda::EventContainer containing an Alda::AtMarker can be created using event list sugar. See Alda::EventList#method_missing.

It should be used together with Alda::Marer. For examples, see Alda::Marker.

Instance Attribute Summary

• #name ⇒ Object

  The corresponding marker’s name.

Attributes inherited from Event

#container, #parent

Instance Method Summary

• #==(other) ⇒ Object

  :call-seq: at_marker == other -> true or false.

• #initialize(name) ⇒ AtMarker constructor

  :call-seq: new(name) -> Alda::AtMarker.

• #to_alda_code ⇒ Object

  :call-seq: to_alda_code() -> String.

Methods inherited from Event

#detach_from_parent, #is_event_of?, #on_contained

Constructor Details

#initialize(name) ⇒ AtMarker

:call-seq:

new(name) -> Alda::AtMarker

Creates an Alda::AtMarker.

Underlines “_” in name is converted to hyphens “-”.

# File 'lib/alda-rb/event.rb', line 1069

def initialize name
	super()
	@name = Alda::Utils.snake_to_slug name
end

Instance Attribute Details

#name ⇒ Object

The corresponding marker’s name

# File 'lib/alda-rb/event.rb', line 1060

def name
  @name
end

Instance Method Details

#==(other) ⇒ Object

:call-seq:

at_marker == other -> true or false

Overrides Alda::Event#==. Returns true if other is an Alda::AtMarker and has the same #name as at_marker (using ==).

# File 'lib/alda-rb/event.rb', line 1090

def == other
	super || other.is_a?(Alda::AtMarker) && @name == other.name
end

#to_alda_code ⇒ Object

:call-seq:

to_alda_code() -> String

Overrides Alda::Event#to_alda_code.

# File 'lib/alda-rb/event.rb', line 1079

def to_alda_code
	?@ + @name
end