plugins/org.eclipse.m2m.atl.emftvm/src/org/eclipse/m2m/atl/emftvm/util/TimingData.java

/*******************************************************************************
 * Copyright (c) 2011 Vrije Universiteit Brussel.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v2.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-2.0/
 *
 * Contributors:
 *     Dennis Wagelaar, Vrije Universiteit Brussel - initial API and
 *         implementation and/or initial documentation
 *******************************************************************************/
package org.eclipse.m2m.atl.emftvm.util;

/**
 * Records time data during the execution of the EMFTVM. 
 * @author <a href="mailto:dennis.wagelaar@vub.ac.be">Dennis Wagelaar</a>
 */
public class TimingData {

	private static final double DIVISOR = 1E9;

	private final long start;
	private long finishedLoading;
	private long finishedMatch;
	private long finishedApply;
	private long finishedPostApply;
	private long finishedRecursive;
	private long finished;

	/**
	 * Creates a new {@link TimingData} object, and starts time measurement.
	 */
	public TimingData() {
		super();
		this.start = System.nanoTime();
	}

	/**
	 * Returns the period until loading was finished in nanoseconds.
	 * @return the period until loading was finished in nanoseconds
	 */
	public long getFinishedLoading() {
		return finishedLoading - start;
	}

	/**
	 * Returns the period until matching was finished in nanoseconds.
	 * @return the period until matching was finished in nanoseconds
	 */
	public long getFinishedMatch() {
		return finishedMatch - start;
	}

	/**
	 * Returns the period until applying was finished in nanoseconds.
	 * @return the period until applying was finished in nanoseconds
	 */
	public long getFinishedApply() {
		return finishedApply - start;
	}

	/**
	 * Returns the period until post-applying was finished in nanoseconds.
	 * @return the period until post-applying was finished in nanoseconds
	 */
	public long getFinishedPostApply() {
		return finishedPostApply - start;
	}

	/**
	 * Returns the period until the recursive stage was finished in nanoseconds.
	 * @return the period until the recursive stage was finished in nanoseconds
	 */
	public long getFinishedRecursive() {
		return finishedRecursive - start;
	}

	/**
	 * Returns the period until execution was finished in nanoseconds.
	 * @return the period until execution was finished in nanoseconds
	 */
	public long getFinished() {
		return finished - start;
	}

	/**
	 * Sets the time when loading is finished.
	 * @param finishedLoading the finishedLoading to set
	 */
	protected void setFinishedLoading(long finishedLoading) {
		this.finishedLoading = finishedLoading;
	}

	/**
	 * Sets the time when matching is finished.
	 * @param finishedMatch the finishedMatch to set
	 */
	protected void setFinishedMatch(long finishedMatch) {
		this.finishedMatch = finishedMatch;
	}

	/**
	 * Sets the time when applying is finished.
	 * @param finishedApply the finishedApply to set
	 */
	protected void setFinishedApply(long finishedApply) {
		this.finishedApply = finishedApply;
	}

	/**
	 * Sets the time when post-applying is finished.
	 * @param finishedPostApply the finishedPostApply to set
	 */
	protected void setFinishedPostApply(long finishedPostApply) {
		this.finishedPostApply = finishedPostApply;
	}

	/**
	 * Sets the time hen the recursive stage is finished.
	 * @param finishedRecursive the finishedRecursive to set
	 */
	protected void setFinishedRecursive(long finishedRecursive) {
		this.finishedRecursive = finishedRecursive;
	}

	/**
	 * Sets the time when all is finished.
	 * @param finished the finished to set
	 */
	protected void setFinished(long finished) {
		this.finished = finished;
	}

	/**
	 * Marks the time when loading finishes.
	 */
	public void finishLoading() {
		this.finishedLoading = System.nanoTime();
	}

	/**
	 * Marks the time when matching finishes.
	 */
	public void finishMatch() {
		this.finishedMatch = System.nanoTime();
	}

	/**
	 * Marks the time when applying finishes.
	 */
	public void finishApply() {
		this.finishedApply = System.nanoTime();
	}

	/**
	 * Marks the time when post-applying finishes.
	 */
	public void finishPostApply() {
		this.finishedPostApply = System.nanoTime();
	}

	/**
	 * Marks the time when the recursive stage finishes.
	 */
	public void finishRecursive() {
		this.finishedRecursive = System.nanoTime();
	}

	/**
	 * Marks the time when execution finishes.
	 */
	public void finish() {
		this.finished = System.nanoTime();
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String toString() {
		StringBuffer sb = new StringBuffer("Timing data:\n");
		sb.append(String.format("\tLoading finished at %f seconds (duration: %f seconds)\n", 
				getFinishedLoading() / DIVISOR, getFinishedLoading() / DIVISOR));
		sb.append(String.format("\tMatching finished at %f seconds (duration: %f seconds)\n", 
				getFinishedMatch() / DIVISOR, (getFinishedMatch() - getFinishedLoading()) / DIVISOR));
		sb.append(String.format("\tApplying finished at %f seconds (duration: %f seconds)\n", 
				getFinishedApply() / DIVISOR, (getFinishedApply() - getFinishedMatch()) / DIVISOR));
		sb.append(String.format("\tPost-applying finished at %f seconds (duration: %f seconds)\n", 
				getFinishedPostApply() / DIVISOR, (getFinishedPostApply() - getFinishedApply()) / DIVISOR));
		sb.append(String.format("\tRecursive stage finished at %f seconds (duration: %f seconds)\n", 
				getFinishedRecursive() / DIVISOR, (getFinishedRecursive() - getFinishedPostApply()) / DIVISOR));
		sb.append(String.format("\tExecution finished at %f seconds (duration: %f seconds)\n", 
				getFinished() / DIVISOR, (getFinished() - getFinishedPostApply()) / DIVISOR));
		return sb.toString();
	}
}