org.eclipse.tracecompass.tmf.core/src/org/eclipse/linuxtools/tmf/core/signal/TmfStartAnalysisSignal.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013 École Polytechnique de Montréal
   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  *   Geneviève Bastien - Initial implementation and API
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.core.signal;
  14
  15 import org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModule;
  16
  17 /**
  18  * Signal indicating an analysis has started. Views and outputs may use it to
  19  * update themselves with the results.
  20  *
  21  * @author Geneviève Bastien
  22  * @since 3.0
  23  */
  24 public class TmfStartAnalysisSignal extends TmfSignal {
  25
  26     private final IAnalysisModule fModule;
  27
  28     /**
  29      * Constructor for a new signal.
  30      *
  31      * @param source
  32      *            The object sending this signal
  33      * @param module
  34      *            The analysis module
  35      */
  36     public TmfStartAnalysisSignal(Object source, IAnalysisModule module) {
  37         super(source);
  38         fModule = module;
  39     }
  40
  41     /**
  42      * Get the trace object concerning this signal
  43      *
  44      * @return The trace
  45      */
  46     public IAnalysisModule getAnalysisModule() {
  47         return fModule;
  48     }
  49
  50     @Override
  51     public String toString() {
  52         return "[" + this.getClass().getSimpleName() + " (" + fModule.getName() + ")]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
  53     }
  54 }