1 /*******************************************************************************
2 * Copyright (c) 2014 École Polytechnique de Montréal
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
10 * Geneviève Bastien - Initial API and implementation
11 *******************************************************************************/
13 package org
.eclipse
.tracecompass
.tmf
.analysis
.xml
.core
.module
;
15 import org
.eclipse
.jdt
.annotation
.NonNull
;
16 import org
.eclipse
.tracecompass
.statesystem
.core
.ITmfStateSystem
;
17 import org
.eclipse
.tracecompass
.tmf
.analysis
.xml
.core
.model
.TmfXmlLocation
;
20 * Interface that all XML defined objects who provide, use or contain state
21 * system must implement in order to use the state provider model elements in
22 * {@link org.eclipse.tracecompass.tmf.analysis.xml.core.model} package
24 * @author Geneviève Bastien
26 public interface IXmlStateSystemContainer
extends ITmfXmlTopLevelElement
{
28 /** Root quark, to get values at the root of the state system */
31 * Error quark, value taken when a state system quark query is in error.
33 * FIXME: Originally in the code, the -1 was used for both root quark and
34 * return errors, so it has the same value as root quark, but maybe it can
35 * be changed to something else -2? A quark can never be negative
40 * Get the state system managed by this XML object
42 * @return The state system
44 ITmfStateSystem
getStateSystem();
47 * Get the list of locations defined in this top level XML element
49 * @return The list of {@link TmfXmlLocation}
51 @NonNull Iterable
<@NonNull TmfXmlLocation
> getLocations();
This page took 0.031398 seconds and 5 git commands to generate.