Container (BandM signal & music)

java.lang.Object
- eu.bandm.tscore.model.Container

All Implemented Interfaces:

Formattable, Cloneable

Direct Known Subclasses:

Part, TimeScape, Vox
```
public class Container
extends Object
implements Cloneable, Formattable
```
Abstract base class of all event collections, which additionally carry some non-temporal ("meta") attributes.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":18.3-30.5, see this pretty print.)

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`conform` Names a Java class which implements the rules for parsing and evaluating.
`protected CheckedMap_RD<String,String>`	`timeless` Collects time-less attributes of this container and its contents.
`protected CheckedMap_RD<String,Vox>`	`voices` Not used in Vox; in TimeScape it holds only timeless parameters for subsequent voices in parts with same name.
`protected CheckedList<Vox>`	`voicesBySource` All voices appearing in the score, in source order of ther first appearance.

Fields inherited from interface eu.bandm.tools.format.Formattable
format

Constructor Summary

Constructors
Constructor and Description

Container()
Synthetic minimal constructor provided by the umod compiler.

Constructors
Constructor and Description
`Container()` Synthetic minimal constructor provided by the umod compiler.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`containsKey_timeless(String key0)` Convenience un-Currying method.
`boolean`	`containsKey_voices(String key0)` Convenience un-Currying method.
`void`	`descend_voices(MATCH_ONLY_00 visitor)`
`void`	`descend_voicesBySource(MATCH_ONLY_00 visitor)`
`Container`	`doclone()` Clones this object.
`Format`	`format()` Delivers a format object for pretty-printing by inheritance from some ancestor class.
`String`	`get_conform()` Names a Java class which implements the rules for parsing and evaluating.
`CheckedMap_RD<String,String>`	`get_timeless()` Collects time-less attributes of this container and its contents.
`CheckedMap_RD<String,Vox>`	`get_voices()` Not used in Vox; in TimeScape it holds only timeless parameters for subsequent voices in parts with same name.
`CheckedList<Vox>`	`get_voicesBySource()` All voices appearing in the score, in source order of ther first appearance.
`Container`	`initFrom(Object o0)` Copies values of all common fields from the argument.
`void`	`put_timeless(String key0, String value)` Convenience un-Currying method.
`void`	`put_voices(String key0, Vox value)` Convenience un-Currying method.
`boolean`	`set_conform(String val)` Names a Java class which implements the rules for parsing and evaluating.
`boolean`	`set_timeless(CheckedMap_RD<String,String> val)` Collects time-less attributes of this container and its contents.
`boolean`	`set_voices(CheckedMap_RD<String,Vox> val)` Not used in Vox; in TimeScape it holds only timeless parameters for subsequent voices in parts with same name.
`boolean`	`set_voicesBySource(CheckedList<Vox> val)` All voices appearing in the score, in source order of ther first appearance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - conform
```
protected String conform
```
    Names a Java class which implements the rules for parsing and evaluating.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":21.5-22.5, see this pretty print.)
    The type of this field is java.lang.String(maybe null)
    Its value defaults to null.
    
    See Also:
    
    get_conform(), set_conform(java.lang.String)
  - timeless
```
protected CheckedMap_RD<String,String> timeless
```
    Collects time-less attributes of this container and its contents. Typical example keys are in MetaKeys
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":23.5-24.5, see this pretty print.)
    The type of this field is CheckedMap_RD<java.lang.String(never null),java.lang.String(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_timeless(), set_timeless(eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, java.lang.String>)
  - voices
```
protected CheckedMap_RD<String,Vox> voices
```
    Not used in Vox; in TimeScape it holds only timeless parameters for subsequent voices in parts with same name. In parts it holds "real" voices with events.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":26.5-27.5, see this pretty print.)
    The type of this field is CheckedMap_RD<java.lang.String(never null),Vox(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_voices(), set_voices(eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tscore.model.Vox>)
  - voicesBySource
```
protected CheckedList<Vox> voicesBySource
```
    All voices appearing in the score, in source order of ther first appearance.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":29.5-30.5, see this pretty print.)
    The type of this field is CheckedList<Vox(never null)>(never null)
    Its value defaults to an empty collection.
    
    See Also:
    
    get_voicesBySource(), set_voicesBySource(eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tscore.model.Vox>)
- Constructor Detail
  - Container
```
public Container()
```
    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 Detail
  - doclone
```
public Container 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
  - initFrom
```
public Container 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_conform
```
public String get_conform()
```
    Names a Java class which implements the rules for parsing and evaluating.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":21.5-22.5, see this pretty print.)
    Generated getter method. @see #conform
    
    Returns:
    
    The current field value of type java.lang.String(maybe null)
  - set_conform
```
public boolean set_conform(String val)
```
    Names a Java class which implements the rules for parsing and evaluating.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":21.5-22.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:
    
    conform
  - get_timeless
```
public CheckedMap_RD<String,String> get_timeless()
```
    Collects time-less attributes of this container and its contents. Typical example keys are in MetaKeys
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":23.5-24.5, see this pretty print.)
    Generated getter method. @see #timeless
    
    Returns:
    
    The current field value of type CheckedMap_RD<java.lang.String(never null),java.lang.String(never null)>(never null)
  - set_timeless
```
public boolean set_timeless(CheckedMap_RD<String,String> val)
```
    Collects time-less attributes of this container and its contents. Typical example keys are in MetaKeys
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":23.5-24.5, see this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedMap_RD<java.lang.String(never null),java.lang.String(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    timeless
  - put_timeless
```
public void put_timeless(String key0,
                         String value)
```
    Convenience un-Currying method.
    Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
    
    Parameters:
    
    val - the new value of type java.lang.String(never null)
    
    See Also:
    
    timeless
  - containsKey_timeless
```
public boolean containsKey_timeless(String key0)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    timeless
  - get_voices
```
public CheckedMap_RD<String,Vox> get_voices()
```
    Not used in Vox; in TimeScape it holds only timeless parameters for subsequent voices in parts with same name. In parts it holds "real" voices with events.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":26.5-27.5, see this pretty print.)
    Generated getter method. @see #voices
    
    Returns:
    
    The current field value of type CheckedMap_RD<java.lang.String(never null),Vox(never null)>(never null)
  - set_voices
```
public boolean set_voices(CheckedMap_RD<String,Vox> val)
```
    Not used in Vox; in TimeScape it holds only timeless parameters for subsequent voices in parts with same name. In parts it holds "real" voices with events.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":26.5-27.5, see this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedMap_RD<java.lang.String(never null),Vox(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    voices
  - put_voices
```
public void put_voices(String key0,
                       Vox value)
```
    Convenience un-Currying method.
    Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.
    
    Parameters:
    
    val - the new value of type Vox(never null)
    
    See Also:
    
    voices
  - containsKey_voices
```
public boolean containsKey_voices(String key0)
```
    Convenience un-Currying method.
    
    Returns:
    
    whether there exists a chain of collection objects to the given co-ordinate.
    
    See Also:
    
    voices
  - descend_voices
```
public void descend_voices(MATCH_ONLY_00 visitor)
```
  - get_voicesBySource
```
public CheckedList<Vox> get_voicesBySource()
```
    All voices appearing in the score, in source order of ther first appearance.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":29.5-30.5, see this pretty print.)
    Generated getter method. @see #voicesBySource
    
    Returns:
    
    The current field value of type CheckedList<Vox(never null)>(never null)
  - set_voicesBySource
```
public boolean set_voicesBySource(CheckedList<Vox> val)
```
    All voices appearing in the score, in source order of ther first appearance.
    
    (This definition has been created by UMod from the source at SYSTEM "tscore.umod":29.5-30.5, see this pretty print.)
    Updates the (mutable) instance destructively.
    
    Parameters:
    
    val - the new value of type CheckedList<Vox(never null)>(never null)
    
    Returns:
    
    whether a change (w.r.t. ==) did actually happen.
    
    See Also:
    
    voicesBySource
  - descend_voicesBySource
```
public void descend_voicesBySource(MATCH_ONLY_00 visitor)
```

Class Container

Field Summary

Fields inherited from interface eu.bandm.tools.format.Formattable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

conform

timeless

voices

voicesBySource

Constructor Detail

Container

Method Detail

doclone

format

initFrom

get_conform

set_conform

get_timeless

set_timeless

put_timeless

containsKey_timeless

get_voices

set_voices

put_voices

containsKey_voices

descend_voices

get_voicesBySource

set_voicesBySource

descend_voicesBySource