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

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2014 É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.tracecompass.tmf.core.signal;
  14
  15 import org.eclipse.tracecompass.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  */
  23 public class TmfStartAnalysisSignal extends TmfSignal {
  24
  25     private final IAnalysisModule fModule;
  26
  27     /**
  28      * Constructor for a new signal.
  29      *
  30      * @param source
  31      *            The object sending this signal
  32      * @param module
  33      *            The analysis module
  34      */
  35     public TmfStartAnalysisSignal(Object source, IAnalysisModule module) {
  36         super(source);
  37         fModule = module;
  38     }
  39
  40     /**
  41      * Get the trace object concerning this signal
  42      *
  43      * @return The trace
  44      */
  45     public IAnalysisModule getAnalysisModule() {
  46         return fModule;
  47     }
  48
  49     @Override
  50     public String toString() {
  51         return "[" + this.getClass().getSimpleName() + " (" + fModule.getName() + ")]"; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
  52     }
  53 }