ctf: Enable the API tool on the CTF plugins

[deliverable/tracecompass.git] / org.eclipse.linuxtools.ctf.core / src / org / eclipse / linuxtools / ctf / core / event / CTFClock.java

/*******************************************************************************
 * Copyright (c) 2011-2012 Ericsson, Ecole Polytechnique de Montreal and others
 *
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors: Matthew Khouzam - Initial API and implementation
 * Contributors: Simon Marchi - Initial API and implementation
 *******************************************************************************/

package org.eclipse.linuxtools.ctf.core.event;

import java.util.HashMap;

/**
 * Clock description used in CTF traces
 */
public class CTFClock {

    private static final String NAME = "name"; //$NON-NLS-1$
    private static final String FREQ = "freq"; //$NON-NLS-1$
    private static final String OFFSET = "offset"; //$NON-NLS-1$

    private long clockOffset = 0;
    private double clockScale = 1.0;
    private double clockAntiScale = 1.0;

    /**
     * Field properties.
     */
    final private HashMap<String, Object> properties = new HashMap<String, Object>();
    /**
     * Field name.
     */
    private String name;
    private boolean isScaled = false;

    /**
     * Default constructor
     */
    public CTFClock() {
    }

    /**
     * Method addAttribute.
     *
     * @param key
     *            String
     * @param value
     *            Object
     */
    public void addAttribute(String key, Object value) {
        this.properties.put(key, value);
        if (key.equals(NAME)) {
            this.name = (String) value;
        }
        if (key.equals(FREQ)) {
            /*
             * Long is converted to a double. the double is then dividing
             * another double that double is saved. this is precise as long as
             * the long is under 53 bits long. this is ok as long as we don't
             * have a system with a frequency of > 1 600 000 000 GHz with
             * 200 ppm precision
             */
            isScaled = !((Long) getProperty(FREQ)).equals(1000000000L);
            clockScale = 1000000000.0 / ((Long) getProperty(FREQ)).doubleValue();
            clockAntiScale = 1.0 / clockScale;

        }
        if (key.equals(OFFSET)) {
            clockOffset = (Long) getProperty(OFFSET);
        }
    }

    /**
     * Method getName.
     *
     * @return String
     */
    public String getName() {
        return name;
    }

    /**
     * Method getProperty.
     *
     * @param key
     *            String
     * @return Object
     */
    public Object getProperty(String key) {
        return properties.get(key);
    }

    /**
     * @return the clockOffset
     * @since 2.0
     */
    public long getClockOffset() {
        return clockOffset;
    }

    /**
     * @return the clockScale
     * @since 2.0
     */
    public double getClockScale() {
        return clockScale;
    }

    /**
     * @return the clockAntiScale
     * @since 2.0
     */
    public double getClockAntiScale() {
        return clockAntiScale;
    }

    /**
     * @return is the clock in ns or cycles?
     * @since 2.0
     */
    public boolean isClockScaled() {
        return isScaled;
    }

}