tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/signal/TmfTraceUpdatedSignal.java

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2014 Ericsson
   3  *
   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
   8  *
   9  * Contributors:
  10  *   Francois Chouinard - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.core.signal;
  14
  15 import org.eclipse.tracecompass.tmf.core.timestamp.TmfTimeRange;
  16 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  17
  18 /**
  19  * Signal indicating a trace has been updated.
  20  *
  21  * The trace has been indexed up to the specified range.
  22  *
  23  * @author Francois Chouinard
  24  */
  25 public class TmfTraceUpdatedSignal extends TmfSignal {
  26
  27     private final ITmfTrace fTrace;
  28     private final TmfTimeRange fTimeRange;
  29     private final long fNbEvents;
  30
  31     /**
  32      * Constructor
  33      *
  34      * @param source
  35      *            Object sending this signal
  36      * @param trace
  37      *            The trace that was updated
  38      * @param range
  39      *            The new time range of the trace
  40      * @param nbEvents
  41      *            The number of events in the trace
  42      */
  43     public TmfTraceUpdatedSignal(Object source, ITmfTrace trace, TmfTimeRange range, long nbEvents) {
  44         super(source);
  45         fTrace = trace;
  46         fTimeRange = range;
  47         fNbEvents = nbEvents;
  48     }
  49
  50     /**
  51      * @return The trace referred to by this signal
  52      */
  53     public ITmfTrace getTrace() {
  54         return fTrace;
  55     }
  56
  57     /**
  58      * @return The time range indicated by this signal
  59      */
  60     public TmfTimeRange getRange() {
  61         return fTimeRange;
  62     }
  63
  64     /**
  65      * Returns the number of events indicated by this signal
  66      *
  67      * @return the number of events indicated by this signal
  68      */
  69     public long getNbEvents() {
  70         return fNbEvents;
  71     }
  72
  73     @Override
  74     @SuppressWarnings("nls")
  75     public String toString() {
  76         return "[TmfTraceUpdatedSignal (" + fTrace.toString() + ", "
  77                 + fTimeRange.toString() + ")]";
  78     }
  79
  80 }