Class MetricParameters.Nota_tempusScribendum

java.lang.Object
eu.bandm.music.entities.MetricParameters.Nota_tempusScribendum
All Implemented Interfaces:
Formattable, Cloneable
Enclosing class:
MetricParameters

public static class MetricParameters.Nota_tempusScribendum extends Object implements Cloneable, Formattable
The parameters for the post-processing of found covers. Controls syncopation, dot notation, sibling merge, etc.
(This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":258.3-308.6, see this pretty print.)
  • Field Details

    • BASE_HASH

      protected static final int BASE_HASH
    • syncope_2_3

      protected boolean syncope_2_3
      Whether to allow a syncope of length 3 appear at time "2".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":263.6-264.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to true .
      See Also:
    • syncope_3_3

      protected boolean syncope_3_3
      Whether to allow a syncope of length 3 appear at time "3".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":266.6-267.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to true .
      See Also:
    • syncope_longer_4

      protected boolean syncope_longer_4
      Whether to allow a syncope of length 5 or longer.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":269.6-270.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to false .
      See Also:
    • merge_may_cross_bracket_limit

      protected boolean merge_may_cross_bracket_limit
      Whether a transformation may cause a bracket to start without a note symbol.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":272.6-273.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to false .
      See Also:
    • no_vanishing_bracket_on_complete_measure

      protected boolean no_vanishing_bracket_on_complete_measure
      If true, each event filling a complete measure of a compound meter is printed as its children.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":275.6-276.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to false .
      See Also:
    • irregular_complete_measure_by_children

      protected boolean irregular_complete_measure_by_children
      If true, each event or pause covering a complete event is replaced by its child nodes, if the meter is "irregular" DEFINITION / IMPL MISSING FIXME
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":280.6-281.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to false .
      See Also:
    • hemiola

      protected boolean hemiola
      Whether hemiolas are used.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":285.6-286.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to true .
      See Also:
    • max_level_syncope_2_sound

      protected int max_level_syncope_2_sound
      How many ancestor levels my be crossed by a simple div-by-2 syncope. (minimum is 1 for any syncopes to appear).
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":289.6-290.6, see this pretty print.)
      The type of this field is int(never null)
      Its value defaults to 3 .
      See Also:
    • max_level_syncope_2_pause

      protected int max_level_syncope_2_pause
      How many ancestor levels my be crossed by a simple div-by-2 syncope. (minimum is 1 for any syncopes to appear).
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":294.6-295.6, see this pretty print.)
      The type of this field is int(never null)
      Its value defaults to 3 .
      See Also:
    • syncope_2_below_odd

      protected boolean syncope_2_below_odd
      Whether the indirect ancestors of a (normal=binary) syncope may be divided non-binary.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":299.6-300.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to false .
      See Also:
    • push_dots_down_not_up

      protected boolean push_dots_down_not_up
      Whether the maximal number of dots shall go with the shorter nodes. E.g. 1/2+1/4... instead of 1/2...+1/32
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":302.6-303.6, see this pretty print.)
      The type of this field is boolean(never null)
      Its value defaults to true .
      See Also:
    • max_childs_over_free_sectioning

      protected int max_childs_over_free_sectioning
      Threshold for printing the child nodes instead of a "free sectioning".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":307.6-308.6, see this pretty print.)
      The type of this field is int(never null)
      Its value defaults to 3 .
      See Also:
  • Constructor Details

    • Nota_tempusScribendum

      public Nota_tempusScribendum()
      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

      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.Nota_tempusScribendum e0)
    • hashCode

      public int hashCode()
      Generated by umod because this class is ALGEBRAIC.
      Overrides:
      hashCode in class Object
    • 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_syncope_2_3

      public boolean get_syncope_2_3()
      Whether to allow a syncope of length 3 appear at time "2".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":263.6-264.6, see this pretty print.)
      Generated getter method. @see #syncope_2_3
      Returns:
      The current field value of type boolean(never null)
    • with_syncope_2_3

      public MetricParameters.Nota_tempusScribendum with_syncope_2_3(boolean val)
      Whether to allow a syncope of length 3 appear at time "2".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":263.6-264.6, 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_syncope_3_3

      public boolean get_syncope_3_3()
      Whether to allow a syncope of length 3 appear at time "3".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":266.6-267.6, see this pretty print.)
      Generated getter method. @see #syncope_3_3
      Returns:
      The current field value of type boolean(never null)
    • with_syncope_3_3

      public MetricParameters.Nota_tempusScribendum with_syncope_3_3(boolean val)
      Whether to allow a syncope of length 3 appear at time "3".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":266.6-267.6, 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_syncope_longer_4

      public boolean get_syncope_longer_4()
      Whether to allow a syncope of length 5 or longer.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":269.6-270.6, see this pretty print.)
      Generated getter method. @see #syncope_longer_4
      Returns:
      The current field value of type boolean(never null)
    • with_syncope_longer_4

      public MetricParameters.Nota_tempusScribendum with_syncope_longer_4(boolean val)
      Whether to allow a syncope of length 5 or longer.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":269.6-270.6, 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_merge_may_cross_bracket_limit

      public boolean get_merge_may_cross_bracket_limit()
      Whether a transformation may cause a bracket to start without a note symbol.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":272.6-273.6, see this pretty print.)
      Generated getter method. @see #merge_may_cross_bracket_limit
      Returns:
      The current field value of type boolean(never null)
    • with_merge_may_cross_bracket_limit

      public MetricParameters.Nota_tempusScribendum with_merge_may_cross_bracket_limit(boolean val)
      Whether a transformation may cause a bracket to start without a note symbol.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":272.6-273.6, 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_no_vanishing_bracket_on_complete_measure

      public boolean get_no_vanishing_bracket_on_complete_measure()
      If true, each event filling a complete measure of a compound meter is printed as its children.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":275.6-276.6, see this pretty print.)
      Generated getter method. @see #no_vanishing_bracket_on_complete_measure
      Returns:
      The current field value of type boolean(never null)
    • with_no_vanishing_bracket_on_complete_measure

      public MetricParameters.Nota_tempusScribendum with_no_vanishing_bracket_on_complete_measure(boolean val)
      If true, each event filling a complete measure of a compound meter is printed as its children.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":275.6-276.6, 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_irregular_complete_measure_by_children

      public boolean get_irregular_complete_measure_by_children()
      If true, each event or pause covering a complete event is replaced by its child nodes, if the meter is "irregular" DEFINITION / IMPL MISSING FIXME
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":280.6-281.6, see this pretty print.)
      Generated getter method. @see #irregular_complete_measure_by_children
      Returns:
      The current field value of type boolean(never null)
    • with_irregular_complete_measure_by_children

      public MetricParameters.Nota_tempusScribendum with_irregular_complete_measure_by_children(boolean val)
      If true, each event or pause covering a complete event is replaced by its child nodes, if the meter is "irregular" DEFINITION / IMPL MISSING FIXME
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":280.6-281.6, 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_hemiola

      public boolean get_hemiola()
      Whether hemiolas are used.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":285.6-286.6, see this pretty print.)
      Generated getter method. @see #hemiola
      Returns:
      The current field value of type boolean(never null)
    • with_hemiola

      public MetricParameters.Nota_tempusScribendum with_hemiola(boolean val)
      Whether hemiolas are used.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":285.6-286.6, 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_max_level_syncope_2_sound

      public int get_max_level_syncope_2_sound()
      How many ancestor levels my be crossed by a simple div-by-2 syncope. (minimum is 1 for any syncopes to appear).
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":289.6-290.6, see this pretty print.)
      Generated getter method. @see #max_level_syncope_2_sound
      Returns:
      The current field value of type int(never null)
    • with_max_level_syncope_2_sound

      public MetricParameters.Nota_tempusScribendum with_max_level_syncope_2_sound(int val)
      How many ancestor levels my be crossed by a simple div-by-2 syncope. (minimum is 1 for any syncopes to appear).
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":289.6-290.6, 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_level_syncope_2_pause

      public int get_max_level_syncope_2_pause()
      How many ancestor levels my be crossed by a simple div-by-2 syncope. (minimum is 1 for any syncopes to appear).
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":294.6-295.6, see this pretty print.)
      Generated getter method. @see #max_level_syncope_2_pause
      Returns:
      The current field value of type int(never null)
    • with_max_level_syncope_2_pause

      public MetricParameters.Nota_tempusScribendum with_max_level_syncope_2_pause(int val)
      How many ancestor levels my be crossed by a simple div-by-2 syncope. (minimum is 1 for any syncopes to appear).
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":294.6-295.6, 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_syncope_2_below_odd

      public boolean get_syncope_2_below_odd()
      Whether the indirect ancestors of a (normal=binary) syncope may be divided non-binary.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":299.6-300.6, see this pretty print.)
      Generated getter method. @see #syncope_2_below_odd
      Returns:
      The current field value of type boolean(never null)
    • with_syncope_2_below_odd

      public MetricParameters.Nota_tempusScribendum with_syncope_2_below_odd(boolean val)
      Whether the indirect ancestors of a (normal=binary) syncope may be divided non-binary.
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":299.6-300.6, 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_push_dots_down_not_up

      public boolean get_push_dots_down_not_up()
      Whether the maximal number of dots shall go with the shorter nodes. E.g. 1/2+1/4... instead of 1/2...+1/32
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":302.6-303.6, see this pretty print.)
      Generated getter method. @see #push_dots_down_not_up
      Returns:
      The current field value of type boolean(never null)
    • with_push_dots_down_not_up

      public MetricParameters.Nota_tempusScribendum with_push_dots_down_not_up(boolean val)
      Whether the maximal number of dots shall go with the shorter nodes. E.g. 1/2+1/4... instead of 1/2...+1/32
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":302.6-303.6, 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_max_childs_over_free_sectioning

      public int get_max_childs_over_free_sectioning()
      Threshold for printing the child nodes instead of a "free sectioning".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":307.6-308.6, see this pretty print.)
      Generated getter method. @see #max_childs_over_free_sectioning
      Returns:
      The current field value of type int(never null)
    • with_max_childs_over_free_sectioning

      public MetricParameters.Nota_tempusScribendum with_max_childs_over_free_sectioning(int val)
      Threshold for printing the child nodes instead of a "free sectioning".
      (This definition has been created by UMod from the source at SYSTEM "MetricParameters.umod":307.6-308.6, 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: