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

   1 /*******************************************************************************
   2  * Copyright (c) 2012, 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  *   Patrick Tasse - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.core.signal;
  14
  15 import org.eclipse.core.resources.IFile;
  16 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  17
  18 /**
  19  * Signal indicating a trace has been opened.
  20  *
  21  * Receivers can get ready to receive TmfTraceRangeUpdatedSignal for coalescing
  22  * and can expect TmfTraceSelectedSignal to follow.
  23  *
  24  * @author Patrick Tasse
  25  */
  26 public class TmfTraceOpenedSignal extends TmfSignal {
  27
  28     private final ITmfTrace fTrace;
  29     private final IFile fEditorFile;
  30
  31     /**
  32      * Constructor for a new signal.
  33      *
  34      * @param source
  35      *            The object sending this signal
  36      * @param trace
  37      *            The trace that has been opened
  38      * @param editorFile
  39      *            Pointer to the editor file
  40      */
  41     public TmfTraceOpenedSignal(Object source, ITmfTrace trace, IFile editorFile) {
  42         super(source);
  43         fTrace = trace;
  44         fEditorFile = editorFile;
  45     }
  46
  47     /**
  48      * Get the trace object concerning this signal
  49      *
  50      * @return The trace
  51      */
  52     public ITmfTrace getTrace() {
  53         return fTrace;
  54     }
  55
  56     /**
  57      * Get a pointer to the editor file for this trace
  58      *
  59      * @return The IFile object
  60      */
  61     public IFile getEditorFile() {
  62         return fEditorFile;
  63     }
  64
  65     @Override
  66     public String toString() {
  67         return "[TmfTraceOpenedSignal (" + fTrace.getName() + ")]"; //$NON-NLS-1$ //$NON-NLS-2$
  68     }
  69 }