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>
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
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.tmf
.core
.statesystem
;
15 import org
.eclipse
.linuxtools
.tmf
.core
.event
.ITmfEvent
;
16 import org
.eclipse
.linuxtools
.tmf
.core
.trace
.ITmfTrace
;
19 * This is the interface used to define the "state change input", which is the
20 * main type of input that goes in the state system.
22 * Usually a state change input, also called "state provider" is the piece of
23 * the pipeline which converts trace events to state changes.
26 * @author Alexandre Montplaisir
28 public interface IStateChangeInput
{
31 * Get the trace with which this state input plugin is associated.
33 * @return The associated trace
35 public ITmfTrace
getTrace();
38 * Return the start time of this "state change input", which is normally the
39 * start time of the originating trace (or it can be the time of the first
40 * state-changing event).
42 * @return The start time
44 public long getStartTime();
47 * Method for the input plugin to specify which type of events it expects.
48 * This will guarantee that all events it receives via processEvent() are
49 * indeed of the given type, so it should be safe to cast to that type.
51 * @return The expected Class of the event. Only events of this class (and
52 * valid subclasses) will be handled.
55 public Class
<?
extends ITmfEvent
> getExpectedEventType();
58 * Assign the target state system where this SCI will insert its state
59 * changes. Because of dependencies issues, this can normally not be done at
62 * This needs to be called before .run()!
65 * Target state system for the state changes generated by this
68 public void assignTargetStateSystem(IStateSystemBuilder ssb
);
71 * Send an event to this input plugin for processing. The implementation
72 * should check the contents, and call the state-modifying methods of its
73 * IStateSystemBuilder object accordingly.
76 * The event (which should be safe to cast to the
77 * expectedEventType) that has to be processed.
79 public void processEvent(ITmfEvent event
);
82 * Indicate to the state history building process that we are done (for now),
83 * and that it should close its current history.
85 public void dispose();
This page took 0.033242 seconds and 5 git commands to generate.