com.skratchdot.electribe.model.esx

Interface Pattern

All Known Implementing Classes:

PatternImpl

public interface Pattern

A representation of the model object 'Pattern'.

The following features are supported:

• Name
• Label
• Tempo
• Swing
• Pattern Length
• Reserved Bit After Pattern Length
• Beat
• Roll Type
• Fx Chain
• Last Step
• Arpeggiator Scale
• Reserved Bits After Arpeggiator Scale
• Arpeggiator Center Note
• Mute Status
• Swing Status
• Output Bus Status
• Accent Status
• Drum Parts
• Keyboard Parts
• Stretch Slice Parts
• Audio In Part
• Accent Part
• Fx Parameters
• Motion Parameters
• Empty
• Pattern Number Original
• Pattern Number Current

See Also:

EsxPackage.getPattern()

Method Summary

Methods

Modifier and Type	Method and Description
PartAccent	getAccentPart() Returns the value of the 'Accent Part' containment reference.
short	getAccentStatus() Returns the value of the 'Accent Status' attribute.
NoteNumber	getArpeggiatorCenterNote() Returns the value of the 'Arpeggiator Center Note' attribute.
ArpeggiatorScale	getArpeggiatorScale() Returns the value of the 'Arpeggiator Scale' attribute.
PartAudioIn	getAudioInPart() Returns the value of the 'Audio In Part' containment reference.
Beat	getBeat() Returns the value of the 'Beat' attribute.
	getDrumParts() Returns the value of the 'Drum Parts' containment reference list.
FxChain	getFxChain() Returns the value of the 'Fx Chain' attribute.
	getFxParameters() Returns the value of the 'Fx Parameters' containment reference list.
	getKeyboardParts() Returns the value of the 'Keyboard Parts' containment reference list.
java.lang.String	getLabel() Returns the value of the 'Label' attribute.
LastStep	getLastStep() Returns the value of the 'Last Step' attribute.
	getMotionParameters() Returns the value of the 'Motion Parameters' containment reference list.
short	getMuteStatus() Returns the value of the 'Mute Status' attribute.
java.lang.String	getName() Returns the value of the 'Name' attribute.
short	getOutputBusStatus() Returns the value of the 'Output Bus Status' attribute.
PatternLength	getPatternLength() Returns the value of the 'Pattern Length' attribute.
PatternNumber	getPatternNumberCurrent() Returns the value of the 'Pattern Number Current' attribute.
PatternNumber	getPatternNumberOriginal() Returns the value of the 'Pattern Number Original' attribute.
byte	getReservedBitAfterPatternLength() Returns the value of the 'Reserved Bit After Pattern Length' attribute.
byte	getReservedBitsAfterArpeggiatorScale() Returns the value of the 'Reserved Bits After Arpeggiator Scale' attribute.
RollType	getRollType() Returns the value of the 'Roll Type' attribute.
	getStretchSliceParts() Returns the value of the 'Stretch Slice Parts' containment reference list.
Swing	getSwing() Returns the value of the 'Swing' attribute.
short	getSwingStatus() Returns the value of the 'Swing Status' attribute.
Tempo	getTempo() Returns the value of the 'Tempo' containment reference.
void	init(byte[] b)
void	init(byte[] b, int patternNumber)
boolean	isEmpty() Returns the value of the 'Empty' attribute.
void	setAccentPart(PartAccent value) Sets the value of the 'Accent Part' containment reference.
void	setAccentStatus(short value) Sets the value of the 'Accent Status' attribute.
void	setArpeggiatorCenterNote(NoteNumber value) Sets the value of the 'Arpeggiator Center Note' attribute.
void	setArpeggiatorScale(ArpeggiatorScale value) Sets the value of the 'Arpeggiator Scale' attribute.
void	setAudioInPart(PartAudioIn value) Sets the value of the 'Audio In Part' containment reference.
void	setBeat(Beat value) Sets the value of the 'Beat' attribute.
void	setFxChain(FxChain value) Sets the value of the 'Fx Chain' attribute.
void	setLastStep(LastStep value) Sets the value of the 'Last Step' attribute.
void	setMuteStatus(short value) Sets the value of the 'Mute Status' attribute.
void	setName(java.lang.String value) Sets the value of the 'Name' attribute.
void	setOutputBusStatus(short value) Sets the value of the 'Output Bus Status' attribute.
void	setPatternLength(PatternLength value) Sets the value of the 'Pattern Length' attribute.
void	setPatternNumberOriginal(PatternNumber value) Sets the value of the 'Pattern Number Original' attribute.
void	setReservedBitAfterPatternLength(byte value) Sets the value of the 'Reserved Bit After Pattern Length' attribute.
void	setReservedBitsAfterArpeggiatorScale(byte value) Sets the value of the 'Reserved Bits After Arpeggiator Scale' attribute.
void	setRollType(RollType value) Sets the value of the 'Roll Type' attribute.
void	setSwing(Swing value) Sets the value of the 'Swing' attribute.
void	setSwingStatus(short value) Sets the value of the 'Swing Status' attribute.
void	setTempo(Tempo value) Sets the value of the 'Tempo' containment reference.
byte[]	toByteArray()

Method Detail

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Name' attribute.

See Also:

setName(String), EsxPackage.getPattern_Name()

setName

void setName(java.lang.String value)

Sets the value of the 'Name' attribute.

Parameters:

value - the new value of the 'Name' attribute.

See Also:

getName()

getLabel

java.lang.String getLabel()

Returns the value of the 'Label' attribute. The default value is "true".

If the meaning of the 'Label' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Label' attribute.

See Also:

EsxPackage.getPattern_Label()

getTempo

Tempo getTempo()

Returns the value of the 'Tempo' containment reference.

If the meaning of the 'Tempo' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Tempo' containment reference.

See Also:

setTempo(Tempo), EsxPackage.getPattern_Tempo()

setTempo

void setTempo(Tempo value)

Sets the value of the 'Tempo' containment reference.

Parameters:

value - the new value of the 'Tempo' containment reference.

See Also:

getTempo()

getSwing

Swing getSwing()

Returns the value of the 'Swing' attribute. The literals are from the enumeration Swing.

If the meaning of the 'Swing' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Swing' attribute.

See Also:

Swing, setSwing(Swing), EsxPackage.getPattern_Swing()

setSwing

void setSwing(Swing value)

Sets the value of the 'Swing' attribute.

Parameters:

value - the new value of the 'Swing' attribute.

See Also:

Swing, getSwing()

getPatternLength

PatternLength getPatternLength()

Returns the value of the 'Pattern Length' attribute. The literals are from the enumeration PatternLength.

If the meaning of the 'Pattern Length' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Pattern Length' attribute.

See Also:

PatternLength, setPatternLength(PatternLength), EsxPackage.getPattern_PatternLength()

setPatternLength

void setPatternLength(PatternLength value)

Sets the value of the 'Pattern Length' attribute.

Parameters:

value - the new value of the 'Pattern Length' attribute.

See Also:

PatternLength, getPatternLength()

getReservedBitAfterPatternLength

byte getReservedBitAfterPatternLength()

Returns the value of the 'Reserved Bit After Pattern Length' attribute.

If the meaning of the 'Reserved Bit After Pattern Length' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Reserved Bit After Pattern Length' attribute.

See Also:

setReservedBitAfterPatternLength(byte), EsxPackage.getPattern_ReservedBitAfterPatternLength()

setReservedBitAfterPatternLength

void setReservedBitAfterPatternLength(byte value)

Sets the value of the 'Reserved Bit After Pattern Length' attribute.

Parameters:

value - the new value of the 'Reserved Bit After Pattern Length' attribute.

See Also:

getReservedBitAfterPatternLength()

getBeat

Beat getBeat()

Returns the value of the 'Beat' attribute. The literals are from the enumeration Beat.

If the meaning of the 'Beat' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Beat' attribute.

See Also:

Beat, setBeat(Beat), EsxPackage.getPattern_Beat()

setBeat

void setBeat(Beat value)

Sets the value of the 'Beat' attribute.

Parameters:

value - the new value of the 'Beat' attribute.

See Also:

Beat, getBeat()

getRollType

RollType getRollType()

Returns the value of the 'Roll Type' attribute. The literals are from the enumeration RollType.

If the meaning of the 'Roll Type' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Roll Type' attribute.

See Also:

RollType, setRollType(RollType), EsxPackage.getPattern_RollType()

setRollType

void setRollType(RollType value)

Sets the value of the 'Roll Type' attribute.

Parameters:

value - the new value of the 'Roll Type' attribute.

See Also:

RollType, getRollType()

getFxChain

FxChain getFxChain()

Returns the value of the 'Fx Chain' attribute. The literals are from the enumeration FxChain.

If the meaning of the 'Fx Chain' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Fx Chain' attribute.

See Also:

FxChain, setFxChain(FxChain), EsxPackage.getPattern_FxChain()

setFxChain

void setFxChain(FxChain value)

Sets the value of the 'Fx Chain' attribute.

Parameters:

value - the new value of the 'Fx Chain' attribute.

See Also:

FxChain, getFxChain()

getLastStep

LastStep getLastStep()

Returns the value of the 'Last Step' attribute. The literals are from the enumeration LastStep.

If the meaning of the 'Last Step' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Last Step' attribute.

See Also:

LastStep, setLastStep(LastStep), EsxPackage.getPattern_LastStep()

setLastStep

void setLastStep(LastStep value)

Sets the value of the 'Last Step' attribute.

Parameters:

value - the new value of the 'Last Step' attribute.

See Also:

LastStep, getLastStep()

getArpeggiatorScale

ArpeggiatorScale getArpeggiatorScale()

Returns the value of the 'Arpeggiator Scale' attribute. The literals are from the enumeration ArpeggiatorScale.

If the meaning of the 'Arpeggiator Scale' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Arpeggiator Scale' attribute.

See Also:

ArpeggiatorScale, setArpeggiatorScale(ArpeggiatorScale), EsxPackage.getPattern_ArpeggiatorScale()

setArpeggiatorScale

void setArpeggiatorScale(ArpeggiatorScale value)

Sets the value of the 'Arpeggiator Scale' attribute.

Parameters:

value - the new value of the 'Arpeggiator Scale' attribute.

See Also:

ArpeggiatorScale, getArpeggiatorScale()

getReservedBitsAfterArpeggiatorScale

byte getReservedBitsAfterArpeggiatorScale()

Returns the value of the 'Reserved Bits After Arpeggiator Scale' attribute.

If the meaning of the 'Reserved Bits After Arpeggiator Scale' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Reserved Bits After Arpeggiator Scale' attribute.

See Also:

setReservedBitsAfterArpeggiatorScale(byte), EsxPackage.getPattern_ReservedBitsAfterArpeggiatorScale()

setReservedBitsAfterArpeggiatorScale

void setReservedBitsAfterArpeggiatorScale(byte value)

Sets the value of the 'Reserved Bits After Arpeggiator Scale' attribute.

Parameters:

value - the new value of the 'Reserved Bits After Arpeggiator Scale' attribute.

See Also:

getReservedBitsAfterArpeggiatorScale()

getArpeggiatorCenterNote

NoteNumber getArpeggiatorCenterNote()

Returns the value of the 'Arpeggiator Center Note' attribute. The literals are from the enumeration NoteNumber.

If the meaning of the 'Arpeggiator Center Note' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Arpeggiator Center Note' attribute.

See Also:

NoteNumber, setArpeggiatorCenterNote(NoteNumber), EsxPackage.getPattern_ArpeggiatorCenterNote()

setArpeggiatorCenterNote

void setArpeggiatorCenterNote(NoteNumber value)

Sets the value of the 'Arpeggiator Center Note' attribute.

Parameters:

value - the new value of the 'Arpeggiator Center Note' attribute.

See Also:

NoteNumber, getArpeggiatorCenterNote()

getMuteStatus

short getMuteStatus()

Returns the value of the 'Mute Status' attribute.

If the meaning of the 'Mute Status' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Mute Status' attribute.

See Also:

setMuteStatus(short), EsxPackage.getPattern_MuteStatus()

setMuteStatus

void setMuteStatus(short value)

Sets the value of the 'Mute Status' attribute.

Parameters:

value - the new value of the 'Mute Status' attribute.

See Also:

getMuteStatus()

getSwingStatus

short getSwingStatus()

Returns the value of the 'Swing Status' attribute.

If the meaning of the 'Swing Status' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Swing Status' attribute.

See Also:

setSwingStatus(short), EsxPackage.getPattern_SwingStatus()

setSwingStatus

void setSwingStatus(short value)

Sets the value of the 'Swing Status' attribute.

Parameters:

value - the new value of the 'Swing Status' attribute.

See Also:

getSwingStatus()

getOutputBusStatus

short getOutputBusStatus()

Returns the value of the 'Output Bus Status' attribute.

If the meaning of the 'Output Bus Status' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Output Bus Status' attribute.

See Also:

setOutputBusStatus(short), EsxPackage.getPattern_OutputBusStatus()

setOutputBusStatus

void setOutputBusStatus(short value)

Sets the value of the 'Output Bus Status' attribute.

Parameters:

value - the new value of the 'Output Bus Status' attribute.

See Also:

getOutputBusStatus()

getAccentStatus

short getAccentStatus()

Returns the value of the 'Accent Status' attribute.

If the meaning of the 'Accent Status' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Accent Status' attribute.

See Also:

setAccentStatus(short), EsxPackage.getPattern_AccentStatus()

setAccentStatus

void setAccentStatus(short value)

Sets the value of the 'Accent Status' attribute.

Parameters:

value - the new value of the 'Accent Status' attribute.

See Also:

getAccentStatus()

getDrumParts

 getDrumParts()

Returns the value of the 'Drum Parts' containment reference list. The list contents are of type PartDrum.

If the meaning of the 'Drum Parts' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Drum Parts' containment reference list.

See Also:

EsxPackage.getPattern_DrumParts()

getKeyboardParts

 getKeyboardParts()

Returns the value of the 'Keyboard Parts' containment reference list. The list contents are of type PartKeyboard.

If the meaning of the 'Keyboard Parts' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Keyboard Parts' containment reference list.

See Also:

EsxPackage.getPattern_KeyboardParts()

getStretchSliceParts

 getStretchSliceParts()

Returns the value of the 'Stretch Slice Parts' containment reference list. The list contents are of type PartStretchSlice.

If the meaning of the 'Stretch Slice Parts' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Stretch Slice Parts' containment reference list.

See Also:

EsxPackage.getPattern_StretchSliceParts()

getAudioInPart

PartAudioIn getAudioInPart()

Returns the value of the 'Audio In Part' containment reference.

If the meaning of the 'Audio In Part' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Audio In Part' containment reference.

See Also:

setAudioInPart(PartAudioIn), EsxPackage.getPattern_AudioInPart()

setAudioInPart

void setAudioInPart(PartAudioIn value)

Sets the value of the 'Audio In Part' containment reference.

Parameters:

value - the new value of the 'Audio In Part' containment reference.

See Also:

getAudioInPart()

getAccentPart

PartAccent getAccentPart()

Returns the value of the 'Accent Part' containment reference.

If the meaning of the 'Accent Part' reference isn't clear, there really should be more of a description here...

Returns:

the value of the 'Accent Part' containment reference.

See Also:

setAccentPart(PartAccent), EsxPackage.getPattern_AccentPart()

setAccentPart

void setAccentPart(PartAccent value)

Sets the value of the 'Accent Part' containment reference.

Parameters:

value - the new value of the 'Accent Part' containment reference.

See Also:

getAccentPart()

getFxParameters

 getFxParameters()

Returns the value of the 'Fx Parameters' containment reference list. The list contents are of type ParametersFx.

If the meaning of the 'Fx Parameters' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Fx Parameters' containment reference list.

See Also:

EsxPackage.getPattern_FxParameters()

getMotionParameters

 getMotionParameters()

Returns the value of the 'Motion Parameters' containment reference list. The list contents are of type ParametersMotion.

If the meaning of the 'Motion Parameters' reference list isn't clear, there really should be more of a description here...

Returns:

the value of the 'Motion Parameters' containment reference list.

See Also:

EsxPackage.getPattern_MotionParameters()

isEmpty

boolean isEmpty()

Returns the value of the 'Empty' attribute. The default value is "true".

If the meaning of the 'Empty' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Empty' attribute.

See Also:

EsxPackage.getPattern_Empty()

getPatternNumberOriginal

PatternNumber getPatternNumberOriginal()

Returns the value of the 'Pattern Number Original' attribute. The default value is "-1". The literals are from the enumeration PatternNumber.

If the meaning of the 'Pattern Number Original' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Pattern Number Original' attribute.

See Also:

PatternNumber, setPatternNumberOriginal(PatternNumber), EsxPackage.getPattern_PatternNumberOriginal()

setPatternNumberOriginal

void setPatternNumberOriginal(PatternNumber value)

Sets the value of the 'Pattern Number Original' attribute.

Parameters:

value - the new value of the 'Pattern Number Original' attribute.

See Also:

PatternNumber, getPatternNumberOriginal()

getPatternNumberCurrent

PatternNumber getPatternNumberCurrent()

Returns the value of the 'Pattern Number Current' attribute. The default value is "-1". The literals are from the enumeration PatternNumber.

If the meaning of the 'Pattern Number Current' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Pattern Number Current' attribute.

See Also:

PatternNumber, EsxPackage.getPattern_PatternNumberCurrent()

init

void init(byte[] b)

init

void init(byte[] b,
        int patternNumber)

toByteArray

byte[] toByteArray()