Commit | Line | Data |
---|---|---|
c068a752 | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2013, 2014 École Polytechnique de Montréal |
c068a752 GB |
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 API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.tmf.core.analysis; |
c068a752 | 14 | |
2bdf0193 | 15 | import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace; |
c068a752 GB |
16 | |
17 | /** | |
18 | * Interface for classes that can provide parameters to analysis when they are | |
19 | * not set manually | |
20 | * | |
21 | * @author Geneviève Bastien | |
22 | */ | |
23 | public interface IAnalysisParameterProvider { | |
24 | ||
25 | // -------------------------------------------------------- | |
26 | // Getters and setters | |
27 | // -------------------------------------------------------- | |
28 | ||
29 | /** | |
30 | * Gets the name of the parameter provider | |
31 | * | |
32 | * @return Name of the parameter provider | |
33 | */ | |
34 | String getName(); | |
35 | ||
36 | /** | |
37 | * Gets the value of a parameter | |
38 | * | |
39 | * @param name | |
40 | * Name of the parameter | |
41 | * @return The value of a parameter | |
42 | */ | |
43 | Object getParameter(String name); | |
44 | ||
45 | // -------------------------------------------------------- | |
46 | // Functionalities | |
47 | // -------------------------------------------------------- | |
48 | ||
49 | /** | |
50 | * Does this parameter provider apply to a given trace | |
51 | * | |
52 | * @param trace | |
53 | * The trace to analyse | |
54 | * @return whether the parameter provider applies | |
55 | */ | |
56 | boolean appliesToTrace(ITmfTrace trace); | |
57 | ||
58 | /** | |
59 | * Register an analysis module to be notified when a parameter value is | |
60 | * changed | |
61 | * | |
62 | * @param module | |
63 | * The listening analysis module | |
64 | */ | |
65 | void registerModule(IAnalysisModule module); | |
66 | ||
67 | } |