eu.bandm.tscore.model

Class EventSet

java.lang.Object

eu.bandm.tscore.model.EventSet

All Implemented Interfaces:

Formattable, Cloneable

public class EventSet
extends Object
implements Cloneable, Formattable

Collections of one or more Events, representing a musical notion.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":195.3-219.5, see this pretty print.)

Field Summary

Fields

Modifier and Type	Field and Description
protected CheckedList<Event>	constructionSequence The sequential order in which the events have been added.
protected String	endText The external representation of the "right" end of the event set, if sensible.
protected CheckedSet<Event>	events All events contained herein.
protected Boolean	hasgaps Wether the set is continguous or has gaps.
protected String	name Name of the sevent set, to identify it.
protected Boolean	overlapping Wether the set is "monodic" or at least two events overlap.
protected String	startText The external representation of the "left" end of the event set, if sensible.
protected CheckedSet<Vox>	voices All voices events of which appear in the set.

Fields inherited from interface eu.bandm.tools.format.Formattable

format

Constructor Summary

Constructors

Constructor and Description
EventSet()
EventSet(String name) Constructor generated according to specification #0 Constructor defined according to directive "C 0/..".
EventSet(String name, String startText) Constructor generated according to specification #1 Constructor defined according to directive "C 1/..".

Method Summary

Modifier and Type	Method and Description
void	add(Event ev)
void	descend_constructionSequence(MATCH_ONLY_00 visitor)
void	descend_events(MATCH_ONLY_00 visitor)
void	descend_voices(MATCH_ONLY_00 visitor)
EventSet	doclone() Clones this object.
Format	format() Delivers a format object for pretty-printing by inheritance from some ancestor class.
CheckedList<Event>	get_constructionSequence() The sequential order in which the events have been added.
String	get_endText() The external representation of the "right" end of the event set, if sensible.
CheckedSet<Event>	get_events() All events contained herein.
Boolean	get_hasgaps() Wether the set is continguous or has gaps.
String	get_name() Name of the sevent set, to identify it.
Boolean	get_overlapping() Wether the set is "monodic" or at least two events overlap.
String	get_startText() The external representation of the "left" end of the event set, if sensible.
CheckedSet<Vox>	get_voices() All voices events of which appear in the set.
EventSet	initFrom(Object o0) Copies values of all common fields from the argument.
boolean	set_constructionSequence(CheckedList<Event> val) The sequential order in which the events have been added.
boolean	set_endText(String val) The external representation of the "right" end of the event set, if sensible.
boolean	set_events(CheckedSet<Event> val) All events contained herein.
boolean	set_hasgaps(Boolean val) Wether the set is continguous or has gaps.
boolean	set_name(String val) Name of the sevent set, to identify it.
boolean	set_overlapping(Boolean val) Wether the set is "monodic" or at least two events overlap.
boolean	set_startText(String val) The external representation of the "left" end of the event set, if sensible.
boolean	set_voices(CheckedSet<Vox> val) All voices events of which appear in the set.

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

Name of the sevent set, to identify it.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":197.5-198.5, see this pretty print.)
The type of this field is java.lang.String(never null)
It is set by every possible constructor.

See Also:

get_name(), set_name(java.lang.String)

events

protected CheckedSet<Event> events

All events contained herein.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":199.5-200.5, see this pretty print.)
The type of this field is CheckedSet<Event(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_events(), set_events(eu.bandm.tools.umod.runtime.CheckedSet<eu.bandm.tscore.model.Event>)

startText

protected String startText

The external representation of the "left" end of the event set, if sensible.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":201.5-202.5, see this pretty print.)
The type of this field is java.lang.String(maybe null)
Its value defaults to null.

See Also:

get_startText(), set_startText(java.lang.String)

endText

protected String endText

The external representation of the "right" end of the event set, if sensible.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":203.5-204.5, see this pretty print.)
The type of this field is java.lang.String(maybe null)
Its value defaults to null.

See Also:

get_endText(), set_endText(java.lang.String)

constructionSequence

protected CheckedList<Event> constructionSequence

The sequential order in which the events have been added.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":205.5-206.5, see this pretty print.)
The type of this field is CheckedList<Event(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_constructionSequence(), set_constructionSequence(eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tscore.model.Event>)

overlapping

protected Boolean overlapping

Wether the set is "monodic" or at least two events overlap. (This value can onyl be set after possibly expensiv analysis.)

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":208.5-209.5, see this pretty print.)
The type of this field is java.lang.Boolean(maybe null)
Its value defaults to null.

See Also:

get_overlapping(), set_overlapping(java.lang.Boolean)

hasgaps

protected Boolean hasgaps

Wether the set is continguous or has gaps. (This value can only be set after possibly expensiv analysis.)

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":211.5-212.5, see this pretty print.)
The type of this field is java.lang.Boolean(maybe null)
Its value defaults to null.

See Also:

get_hasgaps(), set_hasgaps(java.lang.Boolean)

voices

protected CheckedSet<Vox> voices

All voices events of which appear in the set. TOSTRING JAVA return "{EVENT SET \""+name+"\" ,events = "+ constructionSequence +" start/endText = \""+startText+"\"/\""+endText+"\" }" ;

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":214.5-215.5, see this pretty print.)
The type of this field is CheckedSet<Vox(never null)>(maybe null)
Its value defaults to null.

See Also:

get_voices(), set_voices(eu.bandm.tools.umod.runtime.CheckedSet<eu.bandm.tscore.model.Vox>)

Constructor Detail

EventSet

public EventSet(String name)

Constructor generated according to specification #0
Constructor defined according to directive "C 0/..".

Parameters:

name - is copied to field name

EventSet

public EventSet(String name,
                String startText)

Constructor generated according to specification #1
Constructor defined according to directive "C 1/..".

Parameters:

name - is copied to field name

startText - is copied to field startText

EventSet

EventSet()

Method Detail

doclone

public EventSet doclone()

Clones this object. Method never fails, since Cloneable is known to be implemented.

Returns:

a fresh copy.

format

public Format format()

Delivers a format object for pretty-printing by inheritance from some ancestor class.

Specified by:

format in interface Formattable

add

public void add(Event ev)

initFrom

public EventSet initFrom(Object o0)

Copies values of all common fields from the argument. All fields of this class definition are copied, iff the argument is of this class. Then the superclass method is invoked with the same argument.

get_name

public String get_name()

Name of the sevent set, to identify it.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":197.5-198.5, see this pretty print.)
Generated getter method. @see #name

Returns:

The current field value of type java.lang.String(never null)

set_name

public boolean set_name(String val)

Name of the sevent set, to identify it.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":197.5-198.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type java.lang.String(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

name

get_events

public CheckedSet<Event> get_events()

All events contained herein.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":199.5-200.5, see this pretty print.)
Generated getter method. @see #events

Returns:

The current field value of type CheckedSet<Event(never null)>(never null)

set_events

public boolean set_events(CheckedSet<Event> val)

All events contained herein.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":199.5-200.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type CheckedSet<Event(never null)>(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

events

descend_events

public void descend_events(MATCH_ONLY_00 visitor)

get_startText

public String get_startText()

The external representation of the "left" end of the event set, if sensible.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":201.5-202.5, see this pretty print.)
Generated getter method. @see #startText

Returns:

The current field value of type java.lang.String(maybe null)

set_startText

public boolean set_startText(String val)

The external representation of the "left" end of the event set, if sensible.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":201.5-202.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type java.lang.String(maybe null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

startText

get_endText

public String get_endText()

The external representation of the "right" end of the event set, if sensible.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":203.5-204.5, see this pretty print.)
Generated getter method. @see #endText

Returns:

The current field value of type java.lang.String(maybe null)

set_endText

public boolean set_endText(String val)

The external representation of the "right" end of the event set, if sensible.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":203.5-204.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type java.lang.String(maybe null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

endText

get_constructionSequence

public CheckedList<Event> get_constructionSequence()

The sequential order in which the events have been added.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":205.5-206.5, see this pretty print.)
Generated getter method. @see #constructionSequence

Returns:

The current field value of type CheckedList<Event(never null)>(never null)

set_constructionSequence

public boolean set_constructionSequence(CheckedList<Event> val)

The sequential order in which the events have been added.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":205.5-206.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type CheckedList<Event(never null)>(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

constructionSequence

descend_constructionSequence

public void descend_constructionSequence(MATCH_ONLY_00 visitor)

get_overlapping

public Boolean get_overlapping()

Wether the set is "monodic" or at least two events overlap. (This value can onyl be set after possibly expensiv analysis.)

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":208.5-209.5, see this pretty print.)
Generated getter method. @see #overlapping

Returns:

The current field value of type java.lang.Boolean(maybe null)

set_overlapping

public boolean set_overlapping(Boolean val)

Wether the set is "monodic" or at least two events overlap. (This value can onyl be set after possibly expensiv analysis.)

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":208.5-209.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type java.lang.Boolean(maybe null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

overlapping

get_hasgaps

public Boolean get_hasgaps()

Wether the set is continguous or has gaps. (This value can only be set after possibly expensiv analysis.)

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":211.5-212.5, see this pretty print.)
Generated getter method. @see #hasgaps

Returns:

The current field value of type java.lang.Boolean(maybe null)

set_hasgaps

public boolean set_hasgaps(Boolean val)

Wether the set is continguous or has gaps. (This value can only be set after possibly expensiv analysis.)

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":211.5-212.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type java.lang.Boolean(maybe null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

hasgaps

get_voices

public CheckedSet<Vox> get_voices()

All voices events of which appear in the set. TOSTRING JAVA return "{EVENT SET \""+name+"\" ,events = "+ constructionSequence +" start/endText = \""+startText+"\"/\""+endText+"\" }" ;

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":214.5-215.5, see this pretty print.)
Generated getter method. @see #voices

Returns:

The current field value of type CheckedSet<Vox(never null)>(maybe null)

set_voices

public boolean set_voices(CheckedSet<Vox> val)

All voices events of which appear in the set. TOSTRING JAVA return "{EVENT SET \""+name+"\" ,events = "+ constructionSequence +" start/endText = \""+startText+"\"/\""+endText+"\" }" ;

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":214.5-215.5, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type CheckedSet<Vox(never null)>(maybe null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

voices

descend_voices

public void descend_voices(MATCH_ONLY_00 visitor)