org.barrelorgandiscovery.virtualbook

Class Hole

java.lang.Object

org.barrelorgandiscovery.virtualbook.Hole

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Hole>, ITimedLength, ITimedStamped

Direct Known Subclasses:

HoleWithScale

public class Hole
extends java.lang.Object
implements java.lang.Comparable<Hole>, java.io.Serializable, ITimedStamped, ITimedLength

hole representation in the virtual book

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Hole(Hole n) Copy Constructor
Hole(int track, long timestamp, long length) Constructor of hole, given the track no, the timestamp and length (time are in microseconds)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Hole o)
boolean	equals(java.lang.Object obj)
long	getTimeLength() length of the hole in microseconds
long	getTimestamp() Time of the start of the Hole (in Microseconds since the beginning of the Book)
int	getTrack() Get the track of the hole
int	hashCode()
static Hole	intersect(Hole a, Hole b) get the intersection between two holes
boolean	intersect(Region r) function that return intersection with a region
static boolean	isIn(Hole a, Hole b) Teste si la note a est complètement à l'intérieur de b
static boolean	isIntersect(Hole a, Hole b) are two holes intersecting ?
static Hole[]	minus(Hole a, Hole b) Construit l'expression a - b
Hole	newHoleWithMinimumLength(long minimumLength) create a new hole with a minimum length
Hole	newHoleWithOffset(long timestamp) Create a new hole and use an offset
java.lang.String	toString()
static Hole	union(Hole a, Hole b) merge two holes (union operator)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Hole

public Hole(int track,
            long timestamp,
            long length)

Constructor of hole, given the track no, the timestamp and length (time are in microseconds)

Parameters:

track - hole track

timestamp - timestamp in microsecond

length - length of the hole in microsecond

Hole

public Hole(Hole n)

Copy Constructor

Parameters:

n - hole to copy

Method Detail

getTimeLength

public long getTimeLength()

length of the hole in microseconds

Specified by:

getTimeLength in interface ITimedLength

Returns:

getTrack

public int getTrack()

Get the track of the hole

Returns:

getTimestamp

public long getTimestamp()

Time of the start of the Hole (in Microseconds since the beginning of the Book)

Specified by:

getTimestamp in interface ITimedStamped

Returns:

intersect

public boolean intersect(Region r)

function that return intersection with a region

Parameters:

r -

Returns:

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public final int compareTo(Hole o)

Specified by:

compareTo in interface java.lang.Comparable<Hole>

isIntersect

public static final boolean isIntersect(Hole a,
                                        Hole b)

are two holes intersecting ?

Parameters:

a - la première note

b - la seconde note

Returns:

intersect

public static Hole intersect(Hole a,
                             Hole b)

get the intersection between two holes

Parameters:

a - first hole

b - second hole

Returns:

union

public static Hole union(Hole a,
                         Hole b)

merge two holes (union operator)

Parameters:

a - first hole

b - second hole

Returns:

the union of the two holes

isIn

public static boolean isIn(Hole a,
                           Hole b)

Teste si la note a est complètement à l'intérieur de b

Parameters:

a - la première note

b - la note de test

minus

public static Hole[] minus(Hole a,
                           Hole b)

Construit l'expression a - b

Parameters:

a - la note de depart

b - la note de soustraction

Returns:

newHoleWithOffset

public Hole newHoleWithOffset(long timestamp)

Create a new hole and use an offset

Parameters:

timestamp -

Returns:

newHoleWithMinimumLength

public Hole newHoleWithMinimumLength(long minimumLength)

create a new hole with a minimum length

Parameters:

minimumLength -

Returns: