themidibus

Class Note

java.lang.Object

themidibus.Note

public class Note
extends java.lang.Object

The Note class represents a pressed or released key.

Version:

008

Author:

Severin Smith, Marc Koderer

See Also:

MidiBus, ObjectMidiListener, ControlChange

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	bus_name
int	channel
int	pitch
long	ticks
long	timestamp
int	velocity

Constructor Summary

Constructors

Constructor and Description
Note(int channel, int pitch, int velocity) Constructs a Note object
Note(int channel, int pitch, int velocity, int ticks) Constructs a Note object
Note(int channel, int pitch, int velocity, int ticks, long timestamp, java.lang.String bus_name) Constructs a Note object
Note(int channel, int pitch, int velocity, long timestamp, java.lang.String bus_name) Constructs a Note object

Method Summary

Methods

Modifier and Type	Method and Description
int	channel() Return the channel of the Note
boolean	equals(java.lang.Object obj) Check if all fields are equal.
java.lang.String	name() Return the name of the note, e.g.
int	octave() Return the octave of the Note.
int	pitch() Return the pitch of the Note
int	relativePitch() Return the pitch of the Note relative to C.
void	setChannel(int channel) Set channel of the Note
void	setPitch(int pitch) Set pitch of the Note
void	setTicks(int ticks) Set length in ticks of the Note
void	setVelocity(int velocity) Set velocity of the Note
long	ticks() Return the length in ticks of the Note
java.lang.String	toString() Returns a string in the format [Note Name, c:channel, p:pitch, v:velocity, t:ticks, ts:timestamp, b:bus_name] e.g "[C, c:0, p:65, v:123, t:0, ts:1234, b:bus123]".
int	velocity() Return the velocity of the Note

Methods inherited from class java.lang.Object

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

Field Detail

channel

public int channel

pitch

public int pitch

velocity

public int velocity

ticks

public long ticks

timestamp

public long timestamp

bus_name

public java.lang.String bus_name

Constructor Detail

Note

public Note(int channel,
    int pitch,
    int velocity)

Constructs a Note object

Parameters:

channel - the channel of the Note

pitch - the pitch of the Note

velocity - the velocity of the Note

Note

public Note(int channel,
    int pitch,
    int velocity,
    int ticks)

Constructs a Note object

Parameters:

channel - the channel of the Note

pitch - the pitch of the Note

velocity - the velocity of the Note

ticks - the length in ticks of the Note

Note

public Note(int channel,
    int pitch,
    int velocity,
    long timestamp,
    java.lang.String bus_name)

Constructs a Note object

Parameters:

channel - the channel of the Note

pitch - the pitch of the Note

velocity - the velocity of the Note

timestamp - the timestamp of the Note

bus_name - the name of MidiBus associated with the Note

Note

public Note(int channel,
    int pitch,
    int velocity,
    int ticks,
    long timestamp,
    java.lang.String bus_name)

Constructs a Note object

Parameters:

channel - the channel of the Note

pitch - the pitch of the Note

velocity - the velocity of the Note

ticks - the length in ticks of the Note

timestamp - the timestamp of the Note

bus_name - the name of MidiBus associated with the Note

Method Detail

setChannel

public void setChannel(int channel)

Set channel of the Note

Parameters:

channel - the channel to set

channel

public int channel()

Return the channel of the Note

Returns:

the channel

setPitch

public void setPitch(int pitch)

Set pitch of the Note

Parameters:

pitch - the pitch to set

pitch

public int pitch()

Return the pitch of the Note

Returns:

the pitch

relativePitch

public int relativePitch()

Return the pitch of the Note relative to C. Range is 0-12.

Returns:

the relative pitch

octave

public int octave()

Return the octave of the Note. Octaves are divided by the note C

Returns:

the octave

name

public java.lang.String name()

Return the name of the note, e.g. "C" or "G#".

Returns:

the note name

setVelocity

public void setVelocity(int velocity)

Set velocity of the Note

Parameters:

velocity - the velocity to set

velocity

public int velocity()

Return the velocity of the Note

Returns:

the velocity

setTicks

public void setTicks(int ticks)

Set length in ticks of the Note

Parameters:

ticks - the ticks value to set

ticks

public long ticks()

Return the length in ticks of the Note

Returns:

the ticks length

toString

public java.lang.String toString()

Returns a string in the format [Note Name, c:channel, p:pitch, v:velocity, t:ticks, ts:timestamp, b:bus_name] e.g "[C, c:0, p:65, v:123, t:0, ts:1234, b:bus123]". If ticks, timestamp or bus_name isn't set, it is omitted.

Overrides:

toString in class java.lang.Object

Returns:

the string representation

equals

public boolean equals(java.lang.Object obj)

Check if all fields are equal.

Overrides:

equals in class java.lang.Object

Returns:

true if both objects can be considered to be equals