org.youscope.common

Class ExecutionInformation

java.lang.Object

org.youscope.common.ExecutionInformation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class ExecutionInformation
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Information about how many times the currently executed job has already been executed.
The class is immutable.

Author:

Moritz Lang

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ExecutionInformation(ExecutionInformation parentInformation, int loopNumber) Creates a new execution information for the execution of jobs in a loop.
ExecutionInformation(long measurementStartTime, int evaluationNumber) Creates an execution information initialized with the given evaluation number, starting at 0.

Method Summary

Modifier and Type	Method and Description
protected ExecutionInformation	clone()
boolean	equals(java.lang.Object obj)
int	getEvaluationNumber() Returns the main evaluation number, i.e.
java.lang.String	getEvaluationString() Returns a string with the evaluation number followed by the loop numbers, separated by dashes.
int[]	getLoopNumbers() Some jobs may execute their child jobs more than once per execution, in some kind of loop.
long	getMeasurementRuntime() Returns the time in ms of how long the current measurement is already running.
long	getMeasurementStartTime() Returns the absolute time when the measurement was started, in number of milliseconds since January 1, 1970, 00:00:00 GMT.
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionInformation

public ExecutionInformation(long measurementStartTime,
                            int evaluationNumber)

Creates an execution information initialized with the given evaluation number, starting at 0.

Parameters:

measurementStartTime - The time when the measurement was started, in number of milliseconds since January 1, 1970, 00:00:00 GMT.

evaluationNumber - The main evaluation number.

ExecutionInformation

public ExecutionInformation(ExecutionInformation parentInformation,
                            int loopNumber)

Creates a new execution information for the execution of jobs in a loop.

Parameters:

parentInformation - The execution information of the job which represents or executes the looping.

loopNumber - The evaluation number of the loop, starting at 0.

Method Detail

getEvaluationNumber

public int getEvaluationNumber()

Returns the main evaluation number, i.e. how often the task containing this job has already be executed, starting at 0.

Returns:

The number of times the corresponding task has been executed.

getEvaluationString

public java.lang.String getEvaluationString()

Returns a string with the evaluation number followed by the loop numbers, separated by dashes. Note that in the return string the numbering of evaluations and loop numbers starts at one, different to the internal variables which start at zero.

Returns:

String indicating evaluation and loop numbers, separated by dashes, counting from one upwards.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMeasurementStartTime

public long getMeasurementStartTime()

Returns the absolute time when the measurement was started, in number of milliseconds since January 1, 1970, 00:00:00 GMT.

Returns:

The time when the measurement was started, in Unix time.

getMeasurementRuntime

public long getMeasurementRuntime()

Returns the time in ms of how long the current measurement is already running. Note that the runtime is precise only in the moment when the function is called.

Returns:

runtime of the measurement since it was started (not initialized; start occurs after intialization) in ms.

getLoopNumbers

public int[] getLoopNumbers()

Some jobs may execute their child jobs more than once per execution, in some kind of loop. The child jobs should than obtain an execution information with the same evaluation number, but with a loop number indicating the number of times the loop has been executed, starting at 0. Since loops can be in loops, the returned value can contain more than one loop number. The outer loop numbers are stored at the beginning, and the inner at the end of the array.

Returns:

an array indicating the number of times the loops surrounding this job have been executed. Can have the length zero, but is never null.

clone

protected ExecutionInformation clone()

Overrides:

clone in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object