metro

Class DefaultMetroEvent

java.lang.Object

metro.DefaultMetroEvent

All Implemented Interfaces:

MetroDumper, MetroEvent, MetroEventDumper, MetroEventInFrames, MetroEventProcess

Direct Known Subclasses:

DefaultMetroEventMidiEvent, MetroMessageEvent

public abstract class DefaultMetroEvent
extends java.lang.Object
implements MetroEvent

This class is the base class to manage all events that are sent/received between Metro framework and its client.

Author:

Ats Oka

Field Summary

Fields inherited from interface metro.MetroEvent

BAR_OFFSET_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
DefaultMetroEvent(java.lang.String typeName, double barOffset)
DefaultMetroEvent(java.lang.String typeName, int barOffsetInFrames)

Method Summary

Modifier and Type	Method and Description
void	dumpProc(java.lang.String prefix, java.lang.StringBuilder sb)
double	getBarOffset()
int	getBarOffsetInFrames()
java.lang.String	getTypeName()
boolean	isBetween(double from, double to)
boolean	isBetweenInFrames(int from, int to) Check if the position of this event is inside the duration specified in the parameter.
void	prepareBarOffset(int barLengthInFrames)
void	prepareBarOffsetInFrames(int barLengthInFrames)
void	setBarOffset(double barOffset)
void	setBarOffsetInFrames(int barOffsetInFrames)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface metro.MetroEventProcess

process

Methods inherited from interface metro.MetroDumper

dump

Constructor Detail

DefaultMetroEvent

public DefaultMetroEvent(java.lang.String typeName,
                         double barOffset)

DefaultMetroEvent

public DefaultMetroEvent(java.lang.String typeName,
                         int barOffsetInFrames)

Method Detail

getTypeName

public java.lang.String getTypeName()

Specified by:

getTypeName in interface MetroEventDumper

getBarOffset

public final double getBarOffset()

Specified by:

getBarOffset in interface MetroEvent

setBarOffset

public void setBarOffset(double barOffset)

Specified by:

setBarOffset in interface MetroEvent

prepareBarOffset

public final void prepareBarOffset(int barLengthInFrames)

Specified by:

prepareBarOffset in interface MetroEvent

isBetween

public final boolean isBetween(double from,
                               double to)

Specified by:

isBetween in interface MetroEvent

getBarOffsetInFrames

public final int getBarOffsetInFrames()

Specified by:

getBarOffsetInFrames in interface MetroEventInFrames

setBarOffsetInFrames

public void setBarOffsetInFrames(int barOffsetInFrames)

Specified by:

setBarOffsetInFrames in interface MetroEventInFrames

prepareBarOffsetInFrames

public void prepareBarOffsetInFrames(int barLengthInFrames)

Specified by:

prepareBarOffsetInFrames in interface MetroEventInFrames

isBetweenInFrames

public boolean isBetweenInFrames(int from,
                                 int to)

Description copied from interface: MetroEventInFrames

Check if the position of this event is inside the duration specified in the parameter. See MetroTrack.progressCursor(int, List) for further information. This methods is called as a callback of JACKAudio processing; this method should return as soon as possible. The heavy processing that blocks for longer time than the current setting of JACK's frame rate causes JACK to XRUN.

Specified by:

isBetweenInFrames in interface MetroEventInFrames

Parameters:

from - Specifies the beginning point of the duration to check. The value is inclusive.

to - Specifies the end point of the duration to check. The value is exclusive.

Returns:

true if this event is inside the duration.

dumpProc

public void dumpProc(java.lang.String prefix,
                     java.lang.StringBuilder sb)

Specified by:

dumpProc in interface MetroDumper

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object