Package eu.bandm.tscore.model
Class EventSet
java.lang.Object
eu.bandm.tscore.model.EventSet
- All Implemented Interfaces:
Formattable,Cloneable
@Generated(generator="eu.bandm.tools.umod",
version="",
timestamp="2025-08-02_12h46m54")
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":245.3-278.5, see this pretty
print.)-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected CheckedList<Event> The sequential order in which the events have been added.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":261.5-262.5, see this pretty print.)
The type of this field isCheckedList<Event(nevernull)>(nevernull)
Its value defaults to an empty collection.protected StringThe 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":257.5-258.5, see this pretty print.)
The type of this field is java.lang.String(maybenull)
Its value defaults tonull.protected CheckedSet<Event> All events contained herein.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":250.5-251.5, see this pretty print.)
The type of this field isCheckedSet<Event(nevernull)>(nevernull)
Its value defaults to an empty collection.protected BooleanWether the set is continguous or has gaps.protected StringName of the sevent set, to identify it.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":247.5-248.5, see this pretty print.)
The type of this field is java.lang.String(nevernull)
It is set by every possible constructor.protected BooleanWether the set is "monodic" or at least two events overlap.protected StringThe 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":253.5-254.5, see this pretty print.)
The type of this field is java.lang.String(maybenull)
Its value defaults tonull.protected CheckedSet<Vox> All voices events of which appear in the set. -
Constructor Summary
ConstructorsConstructorDescriptionEventSet()Constructor generated according to specification #0
Constructor defined according to directive "C 0/..".Constructor generated according to specification #1
Constructor defined according to directive "C 1/..". -
Method Summary
Modifier and TypeMethodDescriptionvoidvoidDeprecated.voiddescend_events(MATCH_ONLY_00 visitor) Deprecated.voiddescend_voices(MATCH_ONLY_00 visitor) Deprecated.doclone()Clones this object.format()Delivers a format object for pretty-printing by inheritance from some ancestor class.The sequential order in which the events have been added.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":261.5-262.5, see this pretty print.)
Generated getter method.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":257.5-258.5, see this pretty print.)
Generated getter method.All events contained herein.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":250.5-251.5, see this pretty print.)
Generated getter method.Wether the set is continguous or has gaps.get_name()Name of the sevent set, to identify it.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":247.5-248.5, see this pretty print.)
Generated getter method.Wether the set is "monodic" or at least two events overlap.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":253.5-254.5, see this pretty print.)
Generated getter method.All voices events of which appear in the set.Copies values of all common fields from the argument.booleanThe sequential order in which the events have been added.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":261.5-262.5, see this pretty print.)
Updates the (mutable) instance destructively.booleanset_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":257.5-258.5, see this pretty print.)
Updates the (mutable) instance destructively.booleanset_events(CheckedSet<Event> val) All events contained herein.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":250.5-251.5, see this pretty print.)
Updates the (mutable) instance destructively.booleanset_hasgaps(Boolean val) Wether the set is continguous or has gaps.booleanName of the sevent set, to identify it.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":247.5-248.5, see this pretty print.)
Updates the (mutable) instance destructively.booleanset_overlapping(Boolean val) Wether the set is "monodic" or at least two events overlap.booleanset_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":253.5-254.5, see this pretty print.)
Updates the (mutable) instance destructively.booleanset_voices(CheckedSet<Vox> val) All voices events of which appear in the set.
-
Field Details
-
name
Name of the sevent set, to identify it.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":247.5-248.5, see this pretty print.)
The type of this field is java.lang.String(nevernull)
It is set by every possible constructor.- See Also:
-
events
All events contained herein.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":250.5-251.5, see this pretty print.)
The type of this field isCheckedSet<Event(nevernull)>(nevernull)
Its value defaults to an empty collection.- See Also:
-
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":253.5-254.5, see this pretty print.)
The type of this field is java.lang.String(maybenull)
Its value defaults tonull.- See Also:
-
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":257.5-258.5, see this pretty print.)
The type of this field is java.lang.String(maybenull)
Its value defaults tonull.- See Also:
-
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":261.5-262.5, see this pretty print.)
The type of this field isCheckedList<Event(nevernull)>(nevernull)
Its value defaults to an empty collection.- See Also:
-
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":264.5-265.5, see this pretty print.)
The type of this field is java.lang.Boolean(maybenull)
Its value defaults tonull.- See Also:
-
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":268.5-269.5, see this pretty print.)
The type of this field is java.lang.Boolean(maybenull)
Its value defaults tonull.- See Also:
-
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":272.5-273.5, see this pretty print.)
The type of this field isCheckedSet<Vox(nevernull)>(maybenull)
Its value defaults tonull.- See Also:
-
-
Constructor Details
-
EventSet
Constructor generated according to specification #0
Constructor defined according to directive "C 0/..".- Parameters:
name- is copied to fieldname
-
EventSet
Constructor generated according to specification #1
Constructor defined according to directive "C 1/..". -
EventSet
EventSet()
-
-
Method Details
-
doclone
Clones this object. Method never fails, sinceCloneableis known to be implemented.- Returns:
- a fresh copy.
-
format
Delivers a format object for pretty-printing by inheritance from some ancestor class.- Specified by:
formatin interfaceFormattable- Returns:
- a format that represents this object in a pretty-printable way
-
add
-
initFrom
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
Name of the sevent set, to identify it.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":247.5-248.5, see this pretty print.)
Generated getter method.- Returns:
- The current field value of type java.lang.String(never
null) - See Also:
-
set_name
Name of the sevent set, to identify it.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":247.5-248.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val- the new value of type java.lang.String(nevernull)- Returns:
- whether a change (w.r.t.
==) did actually happen. - See Also:
-
get_events
All events contained herein.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":250.5-251.5, see this pretty print.)
Generated getter method.- Returns:
- The current field value of type
CheckedSet<Event(nevernull)>(nevernull) - See Also:
-
set_events
All events contained herein.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":250.5-251.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val- the new value of typeCheckedSet<Event(nevernull)>(nevernull)- Returns:
- whether a change (w.r.t.
==) did actually happen. - See Also:
-
descend_events
Deprecated. -
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":253.5-254.5, see this pretty print.)
Generated getter method.- Returns:
- The current field value of type java.lang.String(maybe
null) - See Also:
-
set_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":253.5-254.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val- the new value of type java.lang.String(maybenull)- Returns:
- whether a change (w.r.t.
==) did actually happen. - See Also:
-
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":257.5-258.5, see this pretty print.)
Generated getter method.- Returns:
- The current field value of type java.lang.String(maybe
null) - See Also:
-
set_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":257.5-258.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val- the new value of type java.lang.String(maybenull)- Returns:
- whether a change (w.r.t.
==) did actually happen. - See Also:
-
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":261.5-262.5, see this pretty print.)
Generated getter method.- Returns:
- The current field value of type
CheckedList<Event(nevernull)>(nevernull) - See Also:
-
set_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":261.5-262.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val- the new value of typeCheckedList<Event(nevernull)>(nevernull)- Returns:
- whether a change (w.r.t.
==) did actually happen. - See Also:
-
descend_constructionSequence
Deprecated. -
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":264.5-265.5, see this pretty print.)
Generated getter method.- Returns:
- The current field value of type java.lang.Boolean(maybe
null) - See Also:
-
set_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":264.5-265.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val- the new value of type java.lang.Boolean(maybenull)- Returns:
- whether a change (w.r.t.
==) did actually happen. - See Also:
-
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":268.5-269.5, see this pretty print.)
Generated getter method.- Returns:
- The current field value of type java.lang.Boolean(maybe
null) - See Also:
-
set_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":268.5-269.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val- the new value of type java.lang.Boolean(maybenull)- Returns:
- whether a change (w.r.t.
==) did actually happen. - See Also:
-
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":272.5-273.5, see this pretty print.)
Generated getter method.- Returns:
- The current field value of type
CheckedSet<Vox(nevernull)>(maybenull) - See Also:
-
set_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":272.5-273.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val- the new value of typeCheckedSet<Vox(nevernull)>(maybenull)- Returns:
- whether a change (w.r.t.
==) did actually happen. - See Also:
-
descend_voices
Deprecated.
-