Package eu.bandm.tscore.model

Class Vox

java.lang.Object
eu.bandm.tscore.model.Container
eu.bandm.tscore.model.Vox
All Implemented Interfaces:
Formattable, Cloneable
public class Vox extends Container
A voice, the central means for organizing events. For every combination of voice and timepoint, at most one event can happen, which in turn may carry arbitrary many parameters.
(This definition has been created by UMod from the source at SYSTEM "tscore.umod":67.3-90.7, see this pretty print.)

  • Field Details

  • Constructor Details

    • Vox

      public Vox(Container context, String name)
      Constructor generated according to specification #0
      Constructor defined according to directive "C 0/..".
      Parameters:
      context - is copied to field context
      name - is copied to field name

    • Vox

      Vox()

  • Method Details

    • doclone

      public Vox doclone()
      Clones this object. Method never fails, since Cloneable is known to be implemented.
      Overrides:
      doclone in class Container
      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
      Overrides:
      format in class Container
      Returns:
      a format that represents this object in a pretty-printable way

    • newEvent

      public Event newEvent(eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier> loc, Tp when)

    • initFrom

      public Vox 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.
      Overrides:
      initFrom in class Container

    • get_context

      public Container get_context()
      The Part which contains this Vox (or TimeScape for time-less global values only).
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":72.7-73.7, see this pretty print.)
      Generated getter method. @see #context
      Overrides:
      get_context in class Container
      Returns:
      The current field value of type Container(never null)

    • set_context

      public boolean set_context(Container val)
      The Part which contains this Vox (or TimeScape for time-less global values only).
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":72.7-73.7, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type Container(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • get_name

      public String get_name()
      Name as it appears eg. in a source file. The name establishes the voice's identity.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":75.7-76.7, 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 as it appears eg. in a source file. The name establishes the voice's identity.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":75.7-76.7, 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 related to this voice.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":78.7-79.7, 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 related to this voice.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":78.7-79.7, 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_sortedByStart

      public CheckedMap_RD<Tp,Event> get_sortedByStart()
      All events related to this voice, sorted by their time point.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":81.7-82.7, see this pretty print.)
      Generated getter method. @see #sortedByStart
      Returns:
      The current field value of type CheckedMap_RD<Tp(never null),Event(never null)>(never null)

    • set_sortedByStart

      public boolean set_sortedByStart(CheckedMap_RD<Tp,Event> val)
      All events related to this voice, sorted by their time point.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":81.7-82.7, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedMap_RD<Tp(never null),Event(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also:

    • put_sortedByStart

      public void put_sortedByStart(Tp key0, Event 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 Event(never null)
      See Also:

    • containsKey_sortedByStart

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

    • descend_sortedByStart

      @Deprecated public void descend_sortedByStart(MATCH_ONLY_00 visitor)
      Deprecated.

    • get_sortedBySource

      public CheckedList<Event> get_sortedBySource()
      All events related to this voice, in sequential order of the source text position, which in nearly all cases corresponds to temporal order.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":84.7-85.7, see this pretty print.)
      Generated getter method. @see #sortedBySource
      Returns:
      The current field value of type CheckedList<Event(never null)>(never null)

    • set_sortedBySource

      public boolean set_sortedBySource(CheckedList<Event> val)
      All events related to this voice, in sequential order of the source text position, which in nearly all cases corresponds to temporal order.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":84.7-85.7, 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_sortedBySource

      @Deprecated public void descend_sortedBySource(MATCH_ONLY_00 visitor)
      Deprecated.

    • get_parameterNames

      public CheckedSet<String> get_parameterNames()
      All parameter names which appear in this voice.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":88.7-89.7, see this pretty print.)
      Generated getter method. @see #parameterNames
      Returns:
      The current field value of type CheckedSet<java.lang.String(never null)>(never null)

    • set_parameterNames

      public boolean set_parameterNames(CheckedSet<String> val)
      All parameter names which appear in this voice.
      (This definition has been created by UMod from the source at SYSTEM "tscore.umod":88.7-89.7, see this pretty print.)
      Updates the (mutable) instance destructively.
      Parameters:
      val - the new value of type CheckedSet<java.lang.String(never null)>(never null)
      Returns:
      whether a change (w.r.t. ==) did actually happen.
      See Also: