metdetection.time

Class TimeTrackerNode

java.lang.Object

metdetection.time.TimeTrackerNode

public class TimeTrackerNode
extends java.lang.Object

A TimeTrackerNode represents the state of a musical score at a given time. That is, it represents a <TimeSignature, Tempo, KeySignature> triple, and contains information about the times at which that triple is contiguously valid.

Author:

Andrew McLeod - 11 Feb, 2015

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isTimeSignatureDummy Whether the Time Signature in this Node is a dummy first node or not.
private KeySignature	keySignature The KeySignature associated with this TimeTrackerNode.
private long	startTick The start tick for this TimeTrackerNode.
private long	startTime The start time for this TimeTrackerNode, measured in microseconds.
private Tempo	tempo The Tempo associated with this TimeTrackerNode.
private TimeSignature	timeSignature The TimeSignature associated with this TimeTrackerNode.

Constructor Summary

Constructors

Constructor and Description
TimeTrackerNode(double ppq) Create a new dummy first TimeTrackerNode at tick and time 0.
TimeTrackerNode(TimeTrackerNode prev, long tick, double ppq) Create a new TimeTrackerNode with the given previous TimeTrackerNode at the given tick.

Method Summary

Methods

Modifier and Type	Method and Description
KeySignature	getKeySignature() Get the KeySignature of this node.
long	getStartTick() Get the start tick of this node.
long	getStartTime() Get the start time of this node.
Tempo	getTempo() Get the Tempo of this node.
long	getTickAtTime(long time, double ppq) Get the tick number at the given time.
long	getTimeAtTick(long tick, double ppq) Get the time at the given tick.
double	getTimePerTick(double ppq) Gets the amount of time, in microseconds, that passes between each tick.
TimeSignature	getTimeSignature() Get the TimeSignature of this node.
boolean	isTimeSignatureDummy() Get if this node has a dummy time signature.
void	setIsTimeSignatureDummy(boolean dummy) Set if this node's time signature is a dummy node.
void	setKeySignature(KeySignature keySignature) Set the KeySignature of this node.
void	setTempo(Tempo tempo) Set the Tempo of this node.
void	setTimeSignature(TimeSignature timeSignature) Set the TimeSignature of this node.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

startTick

private long startTick

The start tick for this TimeTrackerNode. That is, the tick at which this ones triple becomes valid.

startTime

private long startTime

The start time for this TimeTrackerNode, measured in microseconds. That is, the time at which this one's triple becomes valid.

timeSignature

private TimeSignature timeSignature

The TimeSignature associated with this TimeTrackerNode.

tempo

private Tempo tempo

The Tempo associated with this TimeTrackerNode.

keySignature

private KeySignature keySignature

The KeySignature associated with this TimeTrackerNode.

isTimeSignatureDummy

private boolean isTimeSignatureDummy

Whether the Time Signature in this Node is a dummy first node or not.

Constructor Detail

TimeTrackerNode

public TimeTrackerNode(double ppq)

Create a new dummy first TimeTrackerNode at tick and time 0.

Parameters:

ppq - The pulses per quarter note of the song.

TimeTrackerNode

public TimeTrackerNode(TimeTrackerNode prev,
               long tick,
               double ppq)

Create a new TimeTrackerNode with the given previous TimeTrackerNode at the given tick.

Parameters:

prev - The previous TimeTrackerNode, cannot be null.

ppq - The pulses per quarter note of the song.

tick - The tick at which this new one becomes valid.

Method Detail

getTickAtTime

public long getTickAtTime(long time,
                 double ppq)

Get the tick number at the given time.

Parameters:

time - The time at which we want the tick, measured in microseconds.

ppq - The pulses per quarter note of the song.

Returns:

The tick at the given time.

getTimeAtTick

public long getTimeAtTick(long tick,
                 double ppq)

Get the time at the given tick.

Parameters:

tick - The tick at which we want the time.

ppq - The pulses per quarter note of the song.

Returns:

The time at the given tick, measured in microseconds.

getTimePerTick

public double getTimePerTick(double ppq)

Gets the amount of time, in microseconds, that passes between each tick.

Parameters:

ppq - The pulses per quarter note of the song.

Returns:

The length of a tick in microseconds.

getStartTick

public long getStartTick()

Get the start tick of this node.

Returns:

startTick

getStartTime

public long getStartTime()

Get the start time of this node.

Returns:

startTime

setTempo

public void setTempo(Tempo tempo)

Set the Tempo of this node.

Parameters:

tempo -

setTimeSignature

public void setTimeSignature(TimeSignature timeSignature)

Set the TimeSignature of this node.

Parameters:

timeSignature - timeSignature

isTimeSignatureDummy

public boolean isTimeSignatureDummy()

Get if this node has a dummy time signature.

Returns:

isTimeSignatureDummy

setIsTimeSignatureDummy

public void setIsTimeSignatureDummy(boolean dummy)

Set if this node's time signature is a dummy node.

Parameters:

dummy - isTimeSignatureDummy

setKeySignature

public void setKeySignature(KeySignature keySignature)

Set the KeySignature of this node.

Parameters:

keySignature -

getTimeSignature

public TimeSignature getTimeSignature()

Get the TimeSignature of this node.

Returns:

timeSignature

getTempo

public Tempo getTempo()

Get the Tempo of this node.

Returns:

tempo

getKeySignature

public KeySignature getKeySignature()

Get the KeySignature of this node.

Returns:

keySignature

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object