Class: Dilation::Timers::Timer Abstract

Inherits:

Object

• Object
• Dilation::Timers::Timer

Defined in:

lib/dilation/timers/timer.rb

Overview

This class is abstract.

Subclass and override #start and #stop

Author:

• Jim Deville <james.deville@gmail.com>

Direct Known Subclasses

Coarse, Test

Instance Method Summary

• #initialize(target) ⇒ Timer constructor

  A new instance of Timer.

• #running? ⇒ Boolean

  True if this timer is running.

• #start ⇒ Object

  Start this timer.

• #stop ⇒ Object

  Stop this timer.

• #tick ⇒ Object

  This method should be called by subclasses on each tick.

Constructor Details

#initialize(target) ⇒ Timer

Returns a new instance of Timer.

Parameters:

• target (#tick) —

  the object to notify on ticks

# File 'lib/dilation/timers/timer.rb', line 8

def initialize(target)
  @target = target
end

Instance Method Details

#running? ⇒ Boolean

Returns true if this timer is running.

Returns:

• (Boolean) —

  true if this timer is running

# File 'lib/dilation/timers/timer.rb', line 18

def running?
  defined?(@started) && @started
end

#start ⇒ Object

Start this timer

# File 'lib/dilation/timers/timer.rb', line 28

def start
  @started = true
end

#stop ⇒ Object

Stop this timer

# File 'lib/dilation/timers/timer.rb', line 23

def stop
  @started = false
end

#tick ⇒ Object

This method should be called by subclasses on each tick

# File 'lib/dilation/timers/timer.rb', line 13

def tick
  @target.tick
end