1 /*******************************************************************************
2 * Copyright (c) 2012, 2013 Ericsson
4 * All rights reserved. This program and the accompanying materials are
5 * made available under the terms of the Eclipse Public License v1.0 which
6 * accompanies this distribution, and is available at
7 * http://www.eclipse.org/legal/epl-v10.html
10 * Francois Chouinard - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.tracecompass
.tmf
.core
.timestamp
;
15 import org
.eclipse
.tracecompass
.tmf
.core
.event
.ITmfEvent
;
18 * The fundamental time reference in the TMF.
20 * It defines a generic timestamp interface in its most basic form:
22 * <li>timestamp = [value] * 10**[scale] +/- [precision]
26 * <li>[value] is an unstructured integer value
27 * <li>[scale] is the magnitude of the value wrt some application-specific
28 * base unit (e.g. the second)
29 * <li>[precision] indicates the error on the value (useful for comparing
30 * timestamps in different scales). Default: 0.
33 * @author Francois Chouinard
40 public interface ITmfTimestamp
extends Comparable
<ITmfTimestamp
> {
42 // ------------------------------------------------------------------------
44 // ------------------------------------------------------------------------
47 * The millisecond scale factor (10e0)
49 public static final int SECOND_SCALE
= 0;
52 * The millisecond scale factor (10e-3)
54 public static final int MILLISECOND_SCALE
= -3;
57 * The microsecond scale factor (10e-6)
59 public static final int MICROSECOND_SCALE
= -6;
62 * The nanosecond scale factor (10e-9)
64 public static final int NANOSECOND_SCALE
= -9;
66 // ------------------------------------------------------------------------
68 // ------------------------------------------------------------------------
71 * @return the timestamp value (magnitude)
76 * @return the timestamp scale (exponent)
81 * @return the timestamp precision (measurement tolerance)
85 // ------------------------------------------------------------------------
87 // ------------------------------------------------------------------------
90 * Normalize (adjust scale and offset) of the timestamp
92 * @param offset the offset to apply to the timestamp value (after scaling)
93 * @param scale the new timestamp scale
94 * @return a new 'adjusted' ITmfTimestamp
96 ITmfTimestamp
normalize(long offset
, int scale
);
99 * Compares [this] and [ts] within timestamp precision
101 * @param ts the other timestamp
102 * @param withinPrecision consider the precision when testing for equality
103 * @return -1, 0 or 1 (less than, equals, greater than)
105 int compareTo(ITmfTimestamp ts
, boolean withinPrecision
);
108 * Returns the difference between [this] and [ts] as a timestamp
110 * @param ts the other timestamp
111 * @return the time difference (this - other) as an ITmfTimestamp
113 ITmfTimestamp
getDelta(ITmfTimestamp ts
);
116 * Returns if this timestamp intersects the given time range. Borders are
117 * inclusive (for more fine-grained behavior, you can use
118 * {@link #compareTo(ITmfTimestamp)}.
121 * The time range to compare to
122 * @return True if this timestamp is part of the time range, false if not
124 boolean intersects(TmfTimeRange range
);
126 // ------------------------------------------------------------------------
128 // ------------------------------------------------------------------------
131 int compareTo(ITmfTimestamp ts
);
134 * Format the timestamp as per the format provided
136 * @param format the timestamp formatter
137 * @return the formatted timestamp
140 String
toString(final TmfTimestampFormat format
);