Package eu.bandm.tscore.model

Class Event

java.lang.Object
eu.bandm.tscore.model.Event
All Implemented Interfaces:
Formattable, Cloneable
public class Event extends Object implements Cloneable, Formattable
Central means for modelling music: Per each combination of voice and time point, at most one event is possible.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":202.3-224.5, see this pretty print.)

  • Field Details

  • Constructor Details

    • Event

      public Event(eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier> location, Vox voice, Tp when)
      Constructor generated according to specification #0
      Constructor defined according to directive "C 0/..".
      Parameters:
      location - is copied to field location
      voice - is copied to field voice
      when - is copied to field when

    • Event

      Event()

  • Method Details

    • doclone

      public Event 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

    • initFrom

      public Event 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_location

      public eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier> get_location()
      The text position of its external representations.
      (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 #location
      Returns:
      The current field value of type Location(never null)

    • set_location

      public boolean set_location(eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier> val)
      The text position of its external representations.
      (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 Location(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • get_voice

      public Vox get_voice()
      The voice it belongs to.
      (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 #voice
      Returns:
      The current field value of type Vox(never null)

    • set_voice

      public boolean set_voice(Vox val)
      The voice it belongs to.
      (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 Vox(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • get_when

      public Tp get_when()
      The time point when it happens, or begins.
      (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 #when
      Returns:
      The current field value of type Tp(never null)

    • set_when

      public boolean set_when(Tp val)
      The time point when it happens, or begins.
      (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 Tp(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • get_upto

      public Tp get_upto()
      The time point when it ends, if this is sensible.
      (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 #upto
      Returns:
      The current field value of type Tp(maybe null)

    • set_upto

      public boolean set_upto(Tp val)
      The time point when it ends, if this is sensible.
      (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 Tp(maybe null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • get_containedIn

      public CheckedSet<EventSet> get_containedIn()
      All sets of events this event has been added to.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":217.5-218.5, see this pretty print.)
      Generated getter method. @see #containedIn
      Returns:
      The current field value of type CheckedSet<EventSet(never null)>(never null)

    • set_containedIn

      public boolean set_containedIn(CheckedSet<EventSet> val)
      All sets of events this event has been added to.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":217.5-218.5, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedSet<EventSet(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • descend_containedIn

      @Deprecated public void descend_containedIn(MATCH_ONLY_00 visitor)
      Deprecated.

    • get_params

      public CheckedMap_RD<String,CheckedList<CheckedPair_LR<eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier>,String>>> get_params()
      Central means for describing music: All parameters this event can have, sorted by their name.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":220.5-221.5, see this pretty print.)
      Generated getter method. @see #params
      Returns:
      The current field value of type CheckedMap_RD<java.lang.String(never null),CheckedList<CheckedPair_LR<Location(never null),java.lang.String(never null)>(never null)>(never null)>(never null)

    • set_params

      public boolean set_params(CheckedMap_RD<String,CheckedList<CheckedPair_LR<eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier>,String>>> val)
      Central means for describing music: All parameters this event can have, sorted by their name.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":220.5-221.5, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedMap_RD<java.lang.String(never null),CheckedList<CheckedPair_LR<Location(never null),java.lang.String(never null)>(never null)>(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • put_params

      public void put_params(String key0, CheckedList<CheckedPair_LR<eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier>,String>> value)
      Convenience un-Currying method.
      Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
      Parameters:
      value - the new value of type CheckedList<CheckedPair_LR<Location(never null),java.lang.String(never null)>(never null)>(never null)
      See Also:

    • add_params

      public void add_params(String key0, CheckedPair_LR<eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier>,String> value)
      Convenience un-Currying method.
      Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
      Parameters:
      value - the new value of type CheckedPair_LR<Location(never null),java.lang.String(never null)>(never null)
      See Also:

    • containsKey_params

      public boolean containsKey_params(String key0)
      Convenience un-Currying method.
      Returns:
      whether there exists a chain of collection objects to the given co-ordinate.
      See Also:

    • descend_params

      @Deprecated public void descend_params(MATCH_ONLY_00 visitor)
      Deprecated.