Class CtabChannelSettings

java.lang.Object

org.jjazz.yamjjazz.rhythm.api.CtabChannelSettings

public class CtabChannelSettings
extends Object

Corresponds to data in the Ctab structure or ctb2 structure (first part only, 2nd ctb2 part is in the ct2Low/Main/High fields) in the style file, associated to one channel.

For simplification fields are public and can be filled directly by the user, or via the helper methods.

Field Summary

Fields

Modifier and Type	Field	Description
AccType	accType
boolean	autoStart
Ctb2ChannelSettings	ctb2High
Ctb2ChannelSettings	ctb2Low
final Ctb2ChannelSettings	ctb2Main
boolean	editable
ArrayList<YamChord>	mutedChords
ArrayList<Note>	mutedNotes
String	name
Note	sourceChordNote
YamChord	sourceChordType

Constructor Summary

Constructors

Constructor	Description
CtabChannelSettings(int channel)

Method Summary

Modifier and Type	Method	Description
void	dump()
int	getChannel()
int	getCtb2MiddeHighPitch()
int	getCtb2MiddeLowPitch()
ExtChordSymbol	getSourceChordSymbol()
boolean	isMuted(Note n)	True if specified note is one of the muted notes.
boolean	isMuted(YamChord yc)	True if specified YamChord is one of the muted chords.
boolean	isSingleCtb2()	True if there is only one ctb2 for the main/middle note range (no ctb2 for low range or high range).
void	setCtb2MiddleHighPitch(int b1)	Set the middle high pitch.
void	setCtb2MiddleLowPitch(int b1)	Set the middle low pitch.
void	setMutedChords(int b1, int b2, int b3, int b4, int b5)
void	setMutedNotes(int b1, int b2)
void	setSourceChordType(int b1)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

name

public String name

accType

public AccType accType

editable

public boolean editable

mutedNotes

public ArrayList<Note> mutedNotes

autoStart

public boolean autoStart

mutedChords

public ArrayList<YamChord> mutedChords

sourceChordNote

public Note sourceChordNote

sourceChordType

public YamChord sourceChordType

ctb2Low

public Ctb2ChannelSettings ctb2Low

ctb2Main

public final Ctb2ChannelSettings ctb2Main

ctb2High

public Ctb2ChannelSettings ctb2High

Constructor Details

CtabChannelSettings

public CtabChannelSettings(int channel)

Method Details

getSourceChordSymbol

public ExtChordSymbol getSourceChordSymbol()

getChannel

public int getChannel()

Returns:

1-16

getCtb2MiddeLowPitch

public int getCtb2MiddeLowPitch()

setCtb2MiddleLowPitch

public void setCtb2MiddleLowPitch(int b1)

Set the middle low pitch.

This also creates ctb2Low if required.

Parameters:

b1 -

isSingleCtb2

public boolean isSingleCtb2()

True if there is only one ctb2 for the main/middle note range (no ctb2 for low range or high range).

Will always return true for SFF1 files.

Returns:

getCtb2MiddeHighPitch

public int getCtb2MiddeHighPitch()

setCtb2MiddleHighPitch

public void setCtb2MiddleHighPitch(int b1)

Set the middle high pitch.

This also creates ctb2High if required.

Parameters:

b1 -

setSourceChordType

public void setSourceChordType(int b1)

Parameters:

b1 - [0; 0x22]

setMutedChords

public void setMutedChords(int b1,
 int b2,
 int b3,
 int b4,
 int b5)

setMutedNotes

public void setMutedNotes(int b1,
 int b2)

Parameters:

b1 - bit field of the CTAB struct (byte 11)

b2 - bit field of the CTAB struct (byte 12)

isMuted

public boolean isMuted(Note n)

True if specified note is one of the muted notes.

Parameters:

n -

Returns:

isMuted

public boolean isMuted(YamChord yc)

True if specified YamChord is one of the muted chords.

Parameters:

yc -

Returns:

dump

public void dump()