Package eu.bandm.music.entities

Class MetricParameters.MTreeParameters

java.lang.Object
eu.bandm.music.entities.MetricParameters.MTreeParameters
All Implemented Interfaces:
Formattable, Cloneable
Enclosing class:
MetricParameters
public static class MetricParameters.MTreeParameters extends Object implements Cloneable, Formattable
Configuration parameters which describe the general and consistent behaviour of a metric tree in different contexts. Esp. for the automated insertion of essential brackest, and for the selection of beams, beamlets, and flags.
(This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":60.3-169.5, see this pretty print.)

  • Field Details

  • Constructor Details

    • MTreeParameters

      public MTreeParameters()
      Synthetic minimal constructor provided by the umod compiler.
      Constructor with minimal set of arguments, supplied automatically by the umod compiler, not explicitly by user.
      (All object fields are set to their default values.)

  • Method Details

    • doclone

      public MetricParameters.MTreeParameters 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

    • equals

      public boolean equals(Object e0)
      Generated by umod because this class is ALGEBRAIC.
      Overrides:
      equals in class Object

    • x_equals

      public boolean x_equals(MetricParameters.MTreeParameters e0)

    • hashCode

      public int hashCode()
      Generated by umod because this class is ALGEBRAIC.
      Overrides:
      hashCode in class Object

    • initFrom

      public MetricParameters.MTreeParameters 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_longestNoteSymbol

      public int get_longestNoteSymbol()
      Valid values are 1=whole note, 2=brevis, 4=longa, 8=maxima. Most contemporary rendering algorithms support only 1 or 2.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":67.5-68.5, see this pretty print.)
      Generated getter method. @see #longestNoteSymbol
      Returns:
      The current field value of type int(never null)

    • with_longestNoteSymbol

      public MetricParameters.MTreeParameters with_longestNoteSymbol(int val)
      Valid values are 1=whole note, 2=brevis, 4=longa, 8=maxima. Most contemporary rendering algorithms support only 1 or 2.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":67.5-68.5, see this pretty print.)
      Parameters:
      val - the new value of type int(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_max_dots_positive

      public int get_max_dots_positive()
      Maximal allowed prologation dots for positive dottings, Is also used for dot-writings in neutral contexts, when merging siblings / writing Mersenne enumerators etc. Needed already in MTree.install(eu.bandm.music.entities.MTreeSpec, eu.bandm.music.entities.MTree.CheckedParameters), for calculating e-writeability.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":71.5-72.5, see this pretty print.)
      Generated getter method. @see #max_dots_positive
      Returns:
      The current field value of type int(never null)

    • with_max_dots_positive

      public MetricParameters.MTreeParameters with_max_dots_positive(int val)
      Maximal allowed prologation dots for positive dottings, Is also used for dot-writings in neutral contexts, when merging siblings / writing Mersenne enumerators etc. Needed already in MTree.install(eu.bandm.music.entities.MTreeSpec, eu.bandm.music.entities.MTree.CheckedParameters), for calculating e-writeability.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":71.5-72.5, see this pretty print.)
      Parameters:
      val - the new value of type int(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_max_dots_for_pauses

      public int get_max_dots_for_pauses()
      Restricts dots with pause symbols. For all pauses, this restriction is combined with the others. Needed already in MTree.install(eu.bandm.music.entities.MTreeSpec, eu.bandm.music.entities.MTree.CheckedParameters), for calculating e-writeability.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":77.5-78.5, see this pretty print.)
      Generated getter method. @see #max_dots_for_pauses
      Returns:
      The current field value of type int(never null)

    • with_max_dots_for_pauses

      public MetricParameters.MTreeParameters with_max_dots_for_pauses(int val)
      Restricts dots with pause symbols. For all pauses, this restriction is combined with the others. Needed already in MTree.install(eu.bandm.music.entities.MTreeSpec, eu.bandm.music.entities.MTree.CheckedParameters), for calculating e-writeability.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":77.5-78.5, see this pretty print.)
      Parameters:
      val - the new value of type int(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_max_dots_negative

      public int get_max_dots_negative()
      Maximal allowed prologation dots for negative dottings. Needed not yet in MTree.install(eu.bandm.music.entities.MTreeSpec, eu.bandm.music.entities.MTree.CheckedParameters), but only later in MSplitter. For easier maintainance, it shall nevertheless stand here together with the others.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":82.5-83.5, see this pretty print.)
      Generated getter method. @see #max_dots_negative
      Returns:
      The current field value of type int(never null)

    • with_max_dots_negative

      public MetricParameters.MTreeParameters with_max_dots_negative(int val)
      Maximal allowed prologation dots for negative dottings. Needed not yet in MTree.install(eu.bandm.music.entities.MTreeSpec, eu.bandm.music.entities.MTree.CheckedParameters), but only later in MSplitter. For easier maintainance, it shall nevertheless stand here together with the others.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":82.5-83.5, see this pretty print.)
      Parameters:
      val - the new value of type int(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_max_childs_to_print

      public int get_max_childs_to_print()
      Threshold for printing the child nodes, when the parent node is not e-writable.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":87.5-88.5, see this pretty print.)
      Generated getter method. @see #max_childs_to_print
      Returns:
      The current field value of type int(never null)

    • with_max_childs_to_print

      public MetricParameters.MTreeParameters with_max_childs_to_print(int val)
      Threshold for printing the child nodes, when the parent node is not e-writable.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":87.5-88.5, see this pretty print.)
      Parameters:
      val - the new value of type int(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_not_nearest_but_lower_power_of_2

      public boolean get_not_nearest_but_lower_power_of_2()
      Whether to replace essential brackets of "15:16" by "15:8" and "7:8" by "7:4", etc.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":92.5-93.5, see this pretty print.)
      Generated getter method. @see #not_nearest_but_lower_power_of_2
      Returns:
      The current field value of type boolean(never null)

    • with_not_nearest_but_lower_power_of_2

      public MetricParameters.MTreeParameters with_not_nearest_but_lower_power_of_2(boolean val)
      Whether to replace essential brackets of "15:16" by "15:8" and "7:8" by "7:4", etc.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":92.5-93.5, see this pretty print.)
      Parameters:
      val - the new value of type boolean(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_prefer_one_bracket_15_to_16

      public boolean get_prefer_one_bracket_15_to_16()
      Whether one single bracket "15:16" is preferred over two nested brackets "4:5" and "2:3", or sim.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":95.5-96.5, see this pretty print.)
      Generated getter method. @see #prefer_one_bracket_15_to_16
      Returns:
      The current field value of type boolean(never null)

    • with_prefer_one_bracket_15_to_16

      public MetricParameters.MTreeParameters with_prefer_one_bracket_15_to_16(boolean val)
      Whether one single bracket "15:16" is preferred over two nested brackets "4:5" and "2:3", or sim.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":95.5-96.5, see this pretty print.)
      Parameters:
      val - the new value of type boolean(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_prefer_one_bracket_9_to_8

      public boolean get_prefer_one_bracket_9_to_8()
      Whether one single bracket "9:8" is preferred over two nested brackets "2:3", or sim.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":99.5-100.5, see this pretty print.)
      Generated getter method. @see #prefer_one_bracket_9_to_8
      Returns:
      The current field value of type boolean(never null)

    • with_prefer_one_bracket_9_to_8

      public MetricParameters.MTreeParameters with_prefer_one_bracket_9_to_8(boolean val)
      Whether one single bracket "9:8" is preferred over two nested brackets "2:3", or sim.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":99.5-100.5, see this pretty print.)
      Parameters:
      val - the new value of type boolean(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_proportiones_lentiores

      public CheckedSet<Integer> get_proportiones_lentiores()
      Normally a proportion makes the notes play FASTER, like in "7:4". But "7:8" may also be sensible. This set contains the threshold from which on behaviour changes. If e.g. "6" and "13" are contained, then we get "5:4" but "6:8" and "7:8". Then follow "9:8", "11:8", and "13:16".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":103.5-105.5, see this pretty print.)
      Generated getter method. @see #proportiones_lentiores
      Returns:
      The current field value of type CheckedSet<java.lang.Integer(never null)>(never null)

    • with_proportiones_lentiores

      public MetricParameters.MTreeParameters with_proportiones_lentiores(CheckedSet<Integer> val)
      Normally a proportion makes the notes play FASTER, like in "7:4". But "7:8" may also be sensible. This set contains the threshold from which on behaviour changes. If e.g. "6" and "13" are contained, then we get "5:4" but "6:8" and "7:8". Then follow "9:8", "11:8", and "13:16".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":103.5-105.5, see this pretty print.)
      Parameters:
      val - the new value of type CheckedSet<java.lang.Integer(never null)>(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_trabsSopraPausam

      public MetricParameters.nota_trabes_trabsSopraPausam get_trabsSopraPausam()
      @see nota_trabes_trabsSopraPausam
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":113.5-114.5, see this pretty print.)
      Generated getter method. @see #trabsSopraPausam
      Returns:
      The current field value of type MetricParameters.nota_trabes_trabsSopraPausam(never null)

    • with_trabsSopraPausam

      public MetricParameters.MTreeParameters with_trabsSopraPausam(MetricParameters.nota_trabes_trabsSopraPausam val)
      @see nota_trabes_trabsSopraPausam
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":113.5-114.5, see this pretty print.)
      Parameters:
      val - the new value of type MetricParameters.nota_trabes_trabsSopraPausam(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_trabulaSola

      public boolean get_trabulaSola()
      If not set, all-alone beamlets are replaced by flags, as it is usual. But a beamlet can carry additional direction information, which can be ergonomically sensible, e.g. in a 2*5*1/16 meter: 
          
 ___  ___
 |      --|  |--          |
 |        |  |            |
 |        |  |            |
 x        x  x            x

      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":116.5-117.5, see this pretty print.)
      Generated getter method. @see #trabulaSola
      Returns:
      The current field value of type boolean(never null)

    • with_trabulaSola

      public MetricParameters.MTreeParameters with_trabulaSola(boolean val)
      If not set, all-alone beamlets are replaced by flags, as it is usual. But a beamlet can carry additional direction information, which can be ergonomically sensible, e.g. in a 2*5*1/16 meter: 
          
 ___  ___
 |      --|  |--          |
 |        |  |            |
 |        |  |            |
 x        x  x            x

      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":116.5-117.5, see this pretty print.)
      Parameters:
      val - the new value of type boolean(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_trabulaOmnesContraTrabes

      public boolean get_trabulaOmnesContraTrabes()
      Whether to print an additional beamlet pointing to (e.g.) a dotted complement, when it is genuine but not necessary, because the shorter note is divided. See e,g, the beamlet "==" in 
                    ------------
 ---==      |
 ---        |
 | |        |
 x x        x .

      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":129.5-130.5, see this pretty print.)
      Generated getter method. @see #trabulaOmnesContraTrabes
      Returns:
      The current field value of type boolean(never null)

    • with_trabulaOmnesContraTrabes

      public MetricParameters.MTreeParameters with_trabulaOmnesContraTrabes(boolean val)
      Whether to print an additional beamlet pointing to (e.g.) a dotted complement, when it is genuine but not necessary, because the shorter note is divided. See e,g, the beamlet "==" in 
                    ------------
 ---==      |
 ---        |
 | |        |
 x x        x .

      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":129.5-130.5, see this pretty print.)
      Parameters:
      val - the new value of type boolean(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_trabulaContraIdem

      public MetricParameters.nota_trabes_trabulaContraIdem get_trabulaContraIdem()
      @see nota_trabes_trabulaContraIdem
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":142.5-143.5, see this pretty print.)
      Generated getter method. @see #trabulaContraIdem
      Returns:
      The current field value of type MetricParameters.nota_trabes_trabulaContraIdem(never null)

    • with_trabulaContraIdem

      public MetricParameters.MTreeParameters with_trabulaContraIdem(MetricParameters.nota_trabes_trabulaContraIdem val)
      @see nota_trabes_trabulaContraIdem
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":142.5-143.5, see this pretty print.)
      Parameters:
      val - the new value of type MetricParameters.nota_trabes_trabulaContraIdem(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_trabulaNonSubTrabem

      public boolean get_trabulaNonSubTrabem()
      Avoids the conventional but un-orthogonal technique to shift beamlets only to the long-beam-side. This is often the (akward) case with pauses: 
       allows      _______  instead of              _____
 --|   |     the convential       |--  |
 ps     |   |                      ps  |    |
 x   x                           x    x

      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":145.5-146.5, see this pretty print.)
      Generated getter method. @see #trabulaNonSubTrabem
      Returns:
      The current field value of type boolean(never null)

    • with_trabulaNonSubTrabem

      public MetricParameters.MTreeParameters with_trabulaNonSubTrabem(boolean val)
      Avoids the conventional but un-orthogonal technique to shift beamlets only to the long-beam-side. This is often the (akward) case with pauses: 
       allows      _______  instead of              _____
 --|   |     the convential       |--  |
 ps     |   |                      ps  |    |
 x   x                           x    x

      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":145.5-146.5, see this pretty print.)
      Parameters:
      val - the new value of type boolean(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_trabulaUtFlagella

      public boolean get_trabulaUtFlagella()
      Print beamlets as flags, even together with beams. As in 
                    ------------
 |\         |
 | \        |
 | /        |
 x          x .
      Note that this is a mere graphical property.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":156.5-157.5, see this pretty print.)
      Generated getter method. @see #trabulaUtFlagella
      Returns:
      The current field value of type boolean(never null)

    • with_trabulaUtFlagella

      public MetricParameters.MTreeParameters with_trabulaUtFlagella(boolean val)
      Print beamlets as flags, even together with beams. As in 
                    ------------
 |\         |
 | \        |
 | /        |
 x          x .
      Note that this is a mere graphical property.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":156.5-157.5, see this pretty print.)
      Parameters:
      val - the new value of type boolean(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • get_alteraNatas

      public CheckedList<MetricParameters.Nota_trabes_alteraNatas> get_alteraNatas()
      @see Nota_trabes_alteraNatas
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":168.5-169.5, see this pretty print.)
      Generated getter method. @see #alteraNatas
      Returns:
      The current field value of type CheckedList<MetricParameters.Nota_trabes_alteraNatas(never null)>(never null)

    • with_alteraNatas

      public MetricParameters.MTreeParameters with_alteraNatas(CheckedList<MetricParameters.Nota_trabes_alteraNatas> val)
      @see Nota_trabes_alteraNatas
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":168.5-169.5, see this pretty print.)
      Parameters:
      val - the new value of type CheckedList<MetricParameters.Nota_trabes_alteraNatas(never null)>(never null)
      Returns:
      a new instance of the algebraic/immutable data type, with the addressed field set to the new value.
      See Also:

    • descend_alteraNatas

      @Deprecated public void descend_alteraNatas(MetricParameters.MATCH_ONLY_00 visitor)
      Deprecated.