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-01-13_23h06m58") 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":227.3-257.5, see this pretty print.)

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    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":241.5-242.5, see this pretty print.)
    The type of this field is CheckedList<Event(never null)>(never null)
    Its value defaults to an empty collection.

    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":238.5-239.5, see this pretty print.)
    The type of this field is java.lang.String(maybe null)
    Its value defaults to null.

    protected CheckedSet<Event>
    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 is CheckedSet<Event(never null)>(never null)
    Its value defaults to an empty collection.

    protected Boolean
    hasgaps
    Wether the set is continguous or has gaps.
    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":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.

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

    protected CheckedSet<Vox>
    voices
    All voices events of which appear in the set.

  • Constructor Summary

    Constructors
    Constructor
    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
    Description
    void
    add(Event ev)
     
    void
    descend_constructionSequence(MATCH_ONLY_00 visitor)
    Deprecated.
    void
    descend_events(MATCH_ONLY_00 visitor)
    Deprecated.
    void
    descend_voices(MATCH_ONLY_00 visitor)
    Deprecated.
    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.
    (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.
    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":238.5-239.5, see this pretty print.)
    Generated getter method.
    CheckedSet<Event>
    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.
    Boolean
    get_hasgaps()
    Wether the set is continguous or has gaps.
    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":229.5-230.5, see this pretty print.)
    Generated getter method.
    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.
    (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.
    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.
    (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.
    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":238.5-239.5, see this pretty print.)
    Updates the (mutable) instance destructively.
    boolean
    set_events(CheckedSet<Event> val)
    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.
    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.
    (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.
    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.
    (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.
    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 Details

  • Constructor Details

    • 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 Details

    • 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
      Returns:
      a format that represents this object in a pretty-printable way

    • 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":229.5-230.5, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type java.lang.String(never null)
      See Also:

    • 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":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

      public CheckedSet<Event> 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.
      Returns:
      The current field value of type CheckedSet<Event(never null)>(never null)
      See Also:

    • 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":232.5-233.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:

    • descend_events

      @Deprecated public void descend_events(MATCH_ONLY_00 visitor)
      Deprecated.

    • 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":235.5-236.5, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type java.lang.String(maybe null)
      See Also:

    • 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":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

      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":238.5-239.5, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type java.lang.String(maybe null)
      See Also:

    • 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":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

      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":241.5-242.5, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type CheckedList<Event(never null)>(never null)
      See Also:

    • 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":241.5-242.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:

    • descend_constructionSequence

      @Deprecated public void descend_constructionSequence(MATCH_ONLY_00 visitor)
      Deprecated.

    • 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":244.5-245.5, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type java.lang.Boolean(maybe null)
      See Also:

    • 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":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

      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":248.5-249.5, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type java.lang.Boolean(maybe null)
      See Also:

    • 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":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

      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":252.5-253.5, see this pretty print.)
      Generated getter method.
      Returns:
      The current field value of type CheckedSet<Vox(never null)>(maybe null)
      See Also:

    • 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":252.5-253.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:

    • descend_voices

      @Deprecated public void descend_voices(MATCH_ONLY_00 visitor)
      Deprecated.