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":175.3-192.5, see this pretty print.)

Field Summary

Fields

Modifier and Type	Field and Description
protected CheckedSet<EventSet>	containedIn All sets of events this event has been added to.
protected Location<XMLDocumentIdentifier>	location The text position of its external representations.
static String	main_parameter_name
protected CheckedMap_RD<String,CheckedList<CheckedPair_LR<Location<XMLDocumentIdentifier>,String>>>	params Central means for describing music: All parameters this event can have, sorted by their name.
protected Tp	upto The time point when it ends, if this is sensible.
protected Vox	voice The voice it belongs to.
protected Tp	when The time point when it happens, or begins.
static String	when_parameter_name

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

format

Constructor Summary

Constructors

Constructor and Description
Event()
Event(Location<XMLDocumentIdentifier> location, Vox voice, Tp when) Constructor generated according to specification #0 Constructor defined according to directive "C 0/..".

Method Summary

Modifier and Type	Method and Description
void	add_params(String key0, CheckedPair_LR<Location<XMLDocumentIdentifier>,String> value) Convenience un-Currying method.
boolean	containsKey_params(String key0) Convenience un-Currying method.
void	descend_containedIn(MATCH_ONLY_00 visitor)
void	descend_params(MATCH_ONLY_00 visitor)
Event	doclone() Clones this object.
Format	format() Delivers a format object for pretty-printing by inheritance from some ancestor class.
CheckedSet<EventSet>	get_containedIn() All sets of events this event has been added to.
Location<XMLDocumentIdentifier>	get_location() The text position of its external representations.
CheckedMap_RD<String,CheckedList<CheckedPair_LR<Location<XMLDocumentIdentifier>,String>>>	get_params() Central means for describing music: All parameters this event can have, sorted by their name.
Tp	get_upto() The time point when it ends, if this is sensible.
Vox	get_voice() The voice it belongs to.
Tp	get_when() The time point when it happens, or begins.
Event	initFrom(Object o0) Copies values of all common fields from the argument.
void	put_params(String key0, CheckedList<CheckedPair_LR<Location<XMLDocumentIdentifier>,String>> value) Convenience un-Currying method.
boolean	set_containedIn(CheckedSet<EventSet> val) All sets of events this event has been added to.
boolean	set_location(Location<XMLDocumentIdentifier> val) The text position of its external representations.
boolean	set_params(CheckedMap_RD<String,CheckedList<CheckedPair_LR<Location<XMLDocumentIdentifier>,String>>> val) Central means for describing music: All parameters this event can have, sorted by their name.
boolean	set_upto(Tp val) The time point when it ends, if this is sensible.
boolean	set_voice(Vox val) The voice it belongs to.
boolean	set_when(Tp val) The time point when it happens, or begins.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

main_parameter_name

public static final String main_parameter_name

See Also:

Constant Field Values

when_parameter_name

public static final String when_parameter_name

See Also:

Constant Field Values

location

protected Location<XMLDocumentIdentifier> location

The text position of its external representations.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":178.5-179.5, see this pretty print.)
The type of this field is Location(never null)
It is set by every possible constructor.

See Also:

get_location(), set_location(eu.bandm.tools.message.Location<eu.bandm.tools.message.XMLDocumentIdentifier>)

voice

protected Vox voice

The voice it belongs to.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":180.5-181.5, see this pretty print.)
The type of this field is Vox(never null)
It is set by every possible constructor.

See Also:

get_voice(), set_voice(eu.bandm.tscore.model.Vox)

when

protected Tp when

The time point when it happens, or begins.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":182.5-183.5, see this pretty print.)
The type of this field is Tp(never null)
It is set by every possible constructor.

See Also:

get_when(), set_when(eu.bandm.tscore.model.Tp)

upto

protected Tp 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":184.5-185.5, see this pretty print.)
The type of this field is Tp(maybe null)
Its value defaults to null.

See Also:

get_upto(), set_upto(eu.bandm.tscore.model.Tp)

containedIn

protected CheckedSet<EventSet> 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":186.5-187.5, see this pretty print.)
The type of this field is CheckedSet<EventSet(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_containedIn(), set_containedIn(eu.bandm.tools.umod.runtime.CheckedSet<eu.bandm.tscore.model.EventSet>)

params

protected CheckedMap_RD<String,CheckedList<CheckedPair_LR<Location<XMLDocumentIdentifier>,String>>> 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":188.5-189.5, see this pretty print.)
The type of this field is CheckedMap_RD<java.lang.String(never null),CheckedList<CheckedPair_LR<Location(never null),java.lang.String(never null)>(never null)>(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_params(), set_params(eu.bandm.tools.umod.runtime.CheckedMap_RD<java.lang.String, eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tools.umod.runtime.CheckedPair_LR<eu.bandm.tools.message.Location<eu.bandm.tools.message.XMLDocumentIdentifier>, java.lang.String>>>)

Constructor Detail

Event

public Event(Location<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 Detail

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

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 Location<XMLDocumentIdentifier> get_location()

The text position of its external representations.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":178.5-179.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(Location<XMLDocumentIdentifier> val)

The text position of its external representations.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":178.5-179.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:

location

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":180.5-181.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":180.5-181.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:

voice

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":182.5-183.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":182.5-183.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:

when

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":184.5-185.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":184.5-185.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:

upto

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":186.5-187.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":186.5-187.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:

containedIn

descend_containedIn

public void descend_containedIn(MATCH_ONLY_00 visitor)

get_params

public CheckedMap_RD<String,CheckedList<CheckedPair_LR<Location<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":188.5-189.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<Location<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":188.5-189.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:

params

put_params

public void put_params(String key0,
                       CheckedList<CheckedPair_LR<Location<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:

val - the new value of type CheckedList<CheckedPair_LR<Location(never null),java.lang.String(never null)>(never null)>(never null)

See Also:

params

add_params

public void add_params(String key0,
                       CheckedPair_LR<Location<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:

val - the new value of type CheckedPair_LR<Location(never null),java.lang.String(never null)>(never null)

See Also:

params

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:

params

descend_params

public void descend_params(MATCH_ONLY_00 visitor)