Package eu.bandm.tscore.model

Class TpSub

java.lang.Object

eu.bandm.tscore.model.Tp

eu.bandm.tscore.model.TpSub

All Implemented Interfaces:

Formattable, Cloneable

public class TpSub
extends Tp

A time point corresponding to a division point between two time points on a higher level. This division can happen by placing single character markers in the "T" line, or be events which do not fall on such a marker.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	defByEvent	Whether this time points was created by events, not by explicit subdivisions on the "T" time line.
protected TDivision	division	The divistion which defines it.
protected int	pos	the position in the containing division, always != 0 and != the maximal index.

Fields inherited from class eu.bandm.tscore.model.Tp

divisions, endingDivisions, location

Constructor Summary

Constructors

Constructor	Description
TpSub()
TpSub(eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier> location, TDivision division, int pos, boolean defByEvent)	Constructor generated according to specification #0 Constructor defined according to directive "C 0/..".
TpSub(TDivision division, int pos, boolean defByEvent)	Synthetic minimal constructor provided by the umod compiler.

Method Summary

Modifier and Type	Method	Description
TpSub	doclone()	Clones this object.
Format	format()	Delivers a format object for pretty-printing by inheritance from some ancestor class.
boolean	get_defByEvent()	Whether this time points was created by events, not by explicit subdivisions on the "T" time line.
int	get_depth()
TDivision	get_division()	The divistion which defines it.
int	get_pos()	the position in the containing division, always != 0 and != the maximal index.
TpSub	initFrom(Object o0)	Copies values of all common fields from the argument.
boolean	set_defByEvent(boolean val)	Whether this time points was created by events, not by explicit subdivisions on the "T" time line.
boolean	set_division(TDivision val)	The divistion which defines it.
boolean	set_pos(int val)	the position in the containing division, always != 0 and != the maximal index.
String	toString()

Methods inherited from class eu.bandm.tscore.model.Tp

containsKey_divisions, containsKey_divisions, descend_divisions, descend_endingDivisions, get_divisions, get_endingDivisions, get_location, makeDivision, put_divisions, put_divisions, set_divisions, set_endingDivisions, set_location

Methods inherited from class java.lang.Object

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

Field Details

division

protected TDivision division

The divistion which defines it.

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

See Also:

• get_division()
• set_division(eu.bandm.tscore.model.TDivision)

pos

protected int pos

the position in the containing division, always != 0 and != the maximal index.

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

See Also:

• get_pos()
• set_pos(int)

defByEvent

protected boolean defByEvent

Whether this time points was created by events, not by explicit subdivisions on the "T" time line.

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

See Also:

• get_defByEvent()
• set_defByEvent(boolean)

Constructor Details

TpSub

public TpSub(eu.bandm.tools.location.Location<eu.bandm.tools.util.xml.XMLDocumentIdentifier> location,
 TDivision division,
 int pos,
 boolean defByEvent)

Constructor generated according to specification #0
Constructor defined according to directive "C 0/..".

Parameters:

location - is copied to field Tp.location

division - is copied to field division

pos - is copied to field pos

defByEvent - is copied to field defByEvent

TpSub

public TpSub(TDivision division,
 int pos,
 boolean defByEvent)

Synthetic minimal constructor provided by the umod compiler.
Constructor with minimal set of arguments, supplied automatically by the umod compiler, not explicitly by user.

Parameters:

division - is copied to field division

pos - is copied to field pos

defByEvent - is copied to field defByEvent

TpSub

TpSub()

Method Details

doclone

public TpSub doclone()

Clones this object. Method never fails, since Cloneable is known to be implemented.

Overrides:

doclone in class Tp

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 Tp

Returns:

a format that represents this object in a pretty-printable way

toString

public String toString()

Overrides:

toString in class Object

get_depth

public int get_depth()

Specified by:

get_depth in class Tp

initFrom

public TpSub 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 Tp

get_division

public TDivision get_division()

The divistion which defines it.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":185.7-186.7, see this pretty print.)
Generated getter method. @see #division

Returns:

The current field value of type TDivision(never null)

set_division

public boolean set_division(TDivision val)

The divistion which defines it.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":185.7-186.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type TDivision(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

• division

get_pos

public int get_pos()

the position in the containing division, always != 0 and != the maximal index.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":189.7-190.7, see this pretty print.)
Generated getter method. @see #pos

Returns:

The current field value of type int(never null)

set_pos

public boolean set_pos(int val)

the position in the containing division, always != 0 and != the maximal index.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":189.7-190.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type int(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

• pos

get_defByEvent

public boolean get_defByEvent()

Whether this time points was created by events, not by explicit subdivisions on the "T" time line.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":192.7-193.7, see this pretty print.)
Generated getter method. @see #defByEvent

Overrides:

get_defByEvent in class Tp

Returns:

The current field value of type boolean(never null)

set_defByEvent

public boolean set_defByEvent(boolean val)

Whether this time points was created by events, not by explicit subdivisions on the "T" time line.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":192.7-193.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type boolean(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

• defByEvent