triana.types.clipins

Class TimerClipIn

java.lang.Object

triana.types.clipins.TimerClipIn

All Implemented Interfaces:

java.io.Serializable, ClipIn

public class TimerClipIn
extends java.lang.Object
implements ClipIn

A clip-in which records the amount of time spent in each task it passes through

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TIMER_CLIPIN_TAG

Constructor Summary

Constructors

Constructor and Description
TimerClipIn()
TimerClipIn(TimerClipIn clipin)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Clones the ClipIn to an identical one.
void	finalizeAttach(AttachInfo info) This method is called when the clip-in is removed from a task's clip-in bucket.
long	getCurrentStartTime()
long	getDuration()
long	getEndTime()
TimerInfo[]	getSortedTimerInfo()
long	getStartTime()
TimerInfo[]	getTimerInfo()
void	initializeAttach(AttachInfo info) This method is called before the clip-in enters a task's clip-in bucket.

Methods inherited from class java.lang.Object

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

Field Detail

TIMER_CLIPIN_TAG

public static final java.lang.String TIMER_CLIPIN_TAG

See Also:

Constant Field Values

Constructor Detail

TimerClipIn

public TimerClipIn()

TimerClipIn

public TimerClipIn(TimerClipIn clipin)

Method Detail

getStartTime

public long getStartTime()

Returns:

the overall start time of this clipin

getEndTime

public long getEndTime()

Returns:

the overall end time of this clipin (or -1 if not finished)

getDuration

public long getDuration()

Returns:

the overall duration of the clip-in (or -1 if not finished)

getCurrentStartTime

public long getCurrentStartTime()

Returns:

the start time of this clip-in at its current task (or -1 if not initialized at a task)

getTimerInfo

public TimerInfo[] getTimerInfo()

Returns:

an array of the timer infos generated by this clipin

getSortedTimerInfo

public TimerInfo[] getSortedTimerInfo()

Returns:

an array of the timer infos generated by this clip-in sorted by start time

initializeAttach

public void initializeAttach(AttachInfo info)

This method is called before the clip-in enters a task's clip-in bucket. This occurs when either the data it is attached to is input by the task, or when the unit directly adds the clip-in to its bucket.

Specified by:

initializeAttach in interface ClipIn

Parameters:

info - info about the task the clip-in is being attached to

finalizeAttach

public void finalizeAttach(AttachInfo info)

This method is called when the clip-in is removed from a task's clip-in bucket. This occurs when either the data it is attached to is output by the task, or when the unit directly remove the clip-in from its bucket.

Specified by:

finalizeAttach in interface ClipIn

Parameters:

info - info about the task the clip-in is being removed from

clone

public java.lang.Object clone()

Clones the ClipIn to an identical one. This is a copy by value, not by reference. This method must be implemented for each class in a way that depends on the contents of the ClipIn.

Specified by:

clone in interface ClipIn

Overrides:

clone in class java.lang.Object

Returns:

a copy by value of the current ClipIn