org.eclipse.linuxtools.tmf.core/src/org/eclipse/linuxtools/tmf/core/statesystem/IStateChangeInput.java

   1 /*******************************************************************************
   2  * Copyright (c) 2012 Ericsson
   3  * Copyright (c) 2010, 2011 École Polytechnique de Montréal
   4  * Copyright (c) 2010, 2011 Alexandre Montplaisir <alexandre.montplaisir@gmail.com>
   5  *
   6  * All rights reserved. This program and the accompanying materials are
   7  * made available under the terms of the Eclipse Public License v1.0 which
   8  * accompanies this distribution, and is available at
   9  * http://www.eclipse.org/legal/epl-v10.html
  10  *
  11  *******************************************************************************/
  12
  13 package org.eclipse.linuxtools.tmf.core.statesystem;
  14
  15 /**
  16  * This is the interface used to define the "state change input", which is the
  17  * main type of input that goes in the state system.
  18  *
  19  * Usually a state change input, also called "state provider" is the piece of
  20  * the pipeline which converts trace events to state changes.
  21  *
  22  * @author alexmont
  23  *
  24  */
  25 public interface IStateChangeInput extends Runnable {
  26
  27     /**
  28      * Return the start time of this "state change input", which is normally the
  29      * start time of the originating trace (or it can be the time of the first
  30      * state-changing event).
  31      *
  32      * @return The start time
  33      */
  34     public long getStartTime();
  35
  36     /**
  37      * Assign the target state system where this SCI will insert its state
  38      * changes. Because of dependencies issues, this can normally not be done at
  39      * the constructor.
  40      *
  41      * This needs to be called before .run()!
  42      *
  43      * @param ssb
  44      */
  45     public void assignTargetStateSystem(IStateSystemBuilder ssb);
  46 }