com.skratchdot.electribe.model.esx

Interface Song

All Known Implementing Classes:

SongImpl

public interface Song

A representation of the model object 'Song'.

The following features are supported:

• Name
• Tempo
• Tempo Lock
• Song Length
• Mute Hold
• Next Song Number
• Number Of Song Events Current
• Number Of Song Events Original
• Song Patterns
• Song Events
• Empty
• Song Number Original
• Song Number Current

See Also:

EsxPackage.getSong()

Method Summary

Methods

Modifier and Type	Method and Description
MuteHold	getMuteHold() Returns the value of the 'Mute Hold' attribute.
java.lang.String	getName() Returns the value of the 'Name' attribute.
NextSongNumber	getNextSongNumber() Returns the value of the 'Next Song Number' attribute.
short	getNumberOfSongEventsCurrent() Returns the value of the 'Number Of Song Events Current' attribute.
short	getNumberOfSongEventsOriginal() Returns the value of the 'Number Of Song Events Original' attribute.
	getSongEvents() Returns the value of the 'Song Events' containment reference list.
SongLength	getSongLength() Returns the value of the 'Song Length' attribute.
SongNumber	getSongNumberCurrent() Returns the value of the 'Song Number Current' attribute.
SongNumber	getSongNumberOriginal() Returns the value of the 'Song Number Original' attribute.
	getSongPatterns() Returns the value of the 'Song Patterns' containment reference list.
Tempo	getTempo() Returns the value of the 'Tempo' containment reference.
TempoLock	getTempoLock() Returns the value of the 'Tempo Lock' attribute.
void	initSong(byte[] b)
void	initSong(byte[] b, int songNumber)
void	initSongEvents(byte[] b)
boolean	isEmpty() Returns the value of the 'Empty' attribute.
void	setMuteHold(MuteHold value) Sets the value of the 'Mute Hold' attribute.
void	setName(java.lang.String value) Sets the value of the 'Name' attribute.
void	setNextSongNumber(NextSongNumber value) Sets the value of the 'Next Song Number' attribute.
void	setNumberOfSongEventsOriginal(short value) Sets the value of the 'Number Of Song Events Original' attribute.
void	setSongLength(SongLength value) Sets the value of the 'Song Length' attribute.
void	setSongNumberOriginal(SongNumber value) Sets the value of the 'Song Number Original' attribute.
void	setTempo(Tempo value) Sets the value of the 'Tempo' containment reference.
void	setTempoLock(TempoLock value) Sets the value of the 'Tempo Lock' attribute.
byte[]	toSongByteArray()
byte[]	toSongEventsByteArray()

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.getSong_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()

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.getSong_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()

getTempoLock

TempoLock getTempoLock()

Returns the value of the 'Tempo Lock' attribute. The literals are from the enumeration TempoLock.

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

Returns:

the value of the 'Tempo Lock' attribute.

See Also:

TempoLock, setTempoLock(TempoLock), EsxPackage.getSong_TempoLock()

setTempoLock

void setTempoLock(TempoLock value)

Sets the value of the 'Tempo Lock' attribute.

Parameters:

value - the new value of the 'Tempo Lock' attribute.

See Also:

TempoLock, getTempoLock()

getSongLength

SongLength getSongLength()

Returns the value of the 'Song Length' attribute. The literals are from the enumeration SongLength.

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

Returns:

the value of the 'Song Length' attribute.

See Also:

SongLength, setSongLength(SongLength), EsxPackage.getSong_SongLength()

setSongLength

void setSongLength(SongLength value)

Sets the value of the 'Song Length' attribute.

Parameters:

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

See Also:

SongLength, getSongLength()

getMuteHold

MuteHold getMuteHold()

Returns the value of the 'Mute Hold' attribute. The literals are from the enumeration MuteHold.

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

Returns:

the value of the 'Mute Hold' attribute.

See Also:

MuteHold, setMuteHold(MuteHold), EsxPackage.getSong_MuteHold()

setMuteHold

void setMuteHold(MuteHold value)

Sets the value of the 'Mute Hold' attribute.

Parameters:

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

See Also:

MuteHold, getMuteHold()

getNextSongNumber

NextSongNumber getNextSongNumber()

Returns the value of the 'Next Song Number' attribute. The literals are from the enumeration NextSongNumber.

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

Returns:

the value of the 'Next Song Number' attribute.

See Also:

NextSongNumber, setNextSongNumber(NextSongNumber), EsxPackage.getSong_NextSongNumber()

setNextSongNumber

void setNextSongNumber(NextSongNumber value)

Sets the value of the 'Next Song Number' attribute.

Parameters:

value - the new value of the 'Next Song Number' attribute.

See Also:

NextSongNumber, getNextSongNumber()

getNumberOfSongEventsCurrent

short getNumberOfSongEventsCurrent()

Returns the value of the 'Number Of Song Events Current' attribute.

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

Returns:

the value of the 'Number Of Song Events Current' attribute.

See Also:

EsxPackage.getSong_NumberOfSongEventsCurrent()

getNumberOfSongEventsOriginal

short getNumberOfSongEventsOriginal()

Returns the value of the 'Number Of Song Events Original' attribute. The default value is "0".

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

Returns:

the value of the 'Number Of Song Events Original' attribute.

See Also:

setNumberOfSongEventsOriginal(short), EsxPackage.getSong_NumberOfSongEventsOriginal()

setNumberOfSongEventsOriginal

void setNumberOfSongEventsOriginal(short value)

Sets the value of the 'Number Of Song Events Original' attribute.

Parameters:

value - the new value of the 'Number Of Song Events Original' attribute.

See Also:

getNumberOfSongEventsOriginal()

getSongPatterns

 getSongPatterns()

Returns the value of the 'Song Patterns' containment reference list. The list contents are of type SongPattern.

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

Returns:

the value of the 'Song Patterns' containment reference list.

See Also:

EsxPackage.getSong_SongPatterns()

getSongEvents

 getSongEvents()

Returns the value of the 'Song Events' containment reference list. The list contents are of type SongEvent.

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

Returns:

the value of the 'Song Events' containment reference list.

See Also:

EsxPackage.getSong_SongEvents()

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.getSong_Empty()

getSongNumberOriginal

SongNumber getSongNumberOriginal()

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

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

Returns:

the value of the 'Song Number Original' attribute.

See Also:

SongNumber, setSongNumberOriginal(SongNumber), EsxPackage.getSong_SongNumberOriginal()

setSongNumberOriginal

void setSongNumberOriginal(SongNumber value)

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

Parameters:

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

See Also:

SongNumber, getSongNumberOriginal()

getSongNumberCurrent

SongNumber getSongNumberCurrent()

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

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

Returns:

the value of the 'Song Number Current' attribute.

See Also:

SongNumber, EsxPackage.getSong_SongNumberCurrent()

initSong

void initSong(byte[] b)

initSong

void initSong(byte[] b,
            int songNumber)

initSongEvents

void initSongEvents(byte[] b)

toSongByteArray

byte[] toSongByteArray()

toSongEventsByteArray

byte[] toSongEventsByteArray()