Package eu.bandm.tscore.model
Class EventSet
java.lang.Object
eu.bandm.tscore.model.EventSet
- All Implemented Interfaces:
Formattable
,Cloneable
Collections of one or more Events, representing a
musical notion.
(This definition has been created by UMod from
the source at SYSTEM "tscore.umod":227.3-257.5, see this pretty
print.)-
Field Summary
Modifier and TypeFieldDescriptionprotected CheckedList<Event>
The sequential order in which the events have been added.protected String
The external representation of the "right" end of the event set, if sensible.protected CheckedSet<Event>
All events contained herein.protected Boolean
Wether the set is continguous or has gaps.protected String
Name of the sevent set, to identify it.protected Boolean
Wether the set is "monodic" or at least two events overlap.protected String
The external representation of the "left" end of the event set, if sensible.protected CheckedSet<Vox>
All voices events of which appear in the set. -
Constructor Summary
ConstructorDescriptionEventSet()
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 TypeMethodDescriptionvoid
void
Deprecated.void
descend_events
(MATCH_ONLY_00 visitor) Deprecated.void
descend_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.The external representation of the "right" end of the event set, if sensible.All events contained herein.Wether the set is continguous or has gaps.get_name()
Name of the sevent set, to identify it.Wether the set is "monodic" or at least two events overlap.The external representation of the "left" end of the event set, if sensible.All voices events of which appear in the set.Copies values of all common fields from the argument.boolean
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
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.
-
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":229.5-230.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:
-
events
All events contained herein.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":232.5-233.5, see this pretty print.)
The type of this field isCheckedSet
<Event
(never null)>(never null)
Its value defaults to an empty collection. -
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":235.5-236.5, see this pretty print.)
The type of this field is java.lang.String(maybe null)
Its value defaults to null. -
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":238.5-239.5, see this pretty print.)
The type of this field is java.lang.String(maybe null)
Its value defaults to null.- 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":241.5-242.5, see this pretty print.)
The type of this field isCheckedList
<Event
(never null)>(never null)
Its value defaults to an empty collection. -
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":244.5-245.5, see this pretty print.)
The type of this field is java.lang.Boolean(maybe null)
Its value defaults to null. -
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":248.5-249.5, see this pretty print.)
The type of this field is java.lang.Boolean(maybe null)
Its value defaults to null.- 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":252.5-253.5, see this pretty print.)
The type of this field isCheckedSet
<Vox
(never null)>(maybe null)
Its value defaults to null.
-
-
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, sinceCloneable
is known to be implemented.- Returns:
- a fresh copy.
-
format
Delivers a format object for pretty-printing by inheritance from some ancestor class.- Specified by:
format
in 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":229.5-230.5, see this pretty print.)
Generated getter method. @see #name- Returns:
- The current field value of type java.lang.String(never null)
-
set_name
Name of the sevent set, to identify it.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":229.5-230.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:
-
get_events
All events contained herein.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":232.5-233.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
All events contained herein.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":232.5-233.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val
- the new value of typeCheckedSet
<Event
(never null)>(never null)- 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":235.5-236.5, see this pretty print.)
Generated getter method. @see #startText- Returns:
- The current field value of type java.lang.String(maybe null)
-
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":235.5-236.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:
-
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":238.5-239.5, see this pretty print.)
Generated getter method. @see #endText- Returns:
- The current field value of type java.lang.String(maybe null)
-
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":238.5-239.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:
-
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":241.5-242.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
The sequential order in which the events have been added.(This definition has been created by UMod from the source at SYSTEM "tscore.umod":241.5-242.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val
- the new value of typeCheckedList
<Event
(never null)>(never null)- 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":244.5-245.5, see this pretty print.)
Generated getter method. @see #overlapping- Returns:
- The current field value of type java.lang.Boolean(maybe null)
-
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":244.5-245.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:
-
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":248.5-249.5, see this pretty print.)
Generated getter method. @see #hasgaps- Returns:
- The current field value of type java.lang.Boolean(maybe null)
-
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":248.5-249.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:
-
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":252.5-253.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
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":252.5-253.5, see this pretty print.)
Updates the (mutable) instance destructively.- Parameters:
val
- the new value of typeCheckedSet
<Vox
(never null)>(maybe null)- Returns:
- whether a change (w.r.t. ==) did actually happen.
- See Also:
-
descend_voices
Deprecated.
-