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
.tracecompass
.statesystem
.core
.ITmfStateSystem
;
16 import org
.eclipse
.tracecompass
.tmf
.analysis
.xml
.core
.model
.TmfXmlLocation
;
19 * Interface that all XML defined objects who provide, use or contain state
20 * system must implement in order to use the state provider model elements in
21 * {@link org.eclipse.tracecompass.tmf.analysis.xml.core.model} package
23 * @author Geneviève Bastien
25 public interface IXmlStateSystemContainer
extends ITmfXmlTopLevelElement
{
27 /** Root quark, to get values at the root of the state system */
28 static final int ROOT_QUARK
= -1;
30 * Error quark, value taken when a state system quark query is in error.
32 * FIXME: Originally in the code, the -1 was used for both root quark and
33 * return errors, so it has the same value as root quark, but maybe it can
34 * be changed to something else -2? A quark can never be negative
36 static final int ERROR_QUARK
= -1;
39 * Get the state system managed by this XML object
41 * @return The state system
43 ITmfStateSystem
getStateSystem();
46 * Get the list of locations defined in this top level XML element
48 * @return The list of {@link TmfXmlLocation}
50 Iterable
<TmfXmlLocation
> getLocations();
This page took 0.101983 seconds and 5 git commands to generate.