analysis/org.eclipse.tracecompass.analysis.graph.core/src/org/eclipse/tracecompass/analysis/graph/core/base/ITmfGraphVisitor.java

   1 /*******************************************************************************
   2  * Copyright (c) 2015 École Polytechnique de Montréal
   3  *
   4  * All rights reserved. This program and the accompanying materials are made
   5  * 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  *   Francis Giraldeau - Initial implementation and API
  11  *   Geneviève Bastien - Initial implementation and API
  12  *******************************************************************************/
  13
  14 package org.eclipse.tracecompass.analysis.graph.core.base;
  15
  16 /**
  17  * Interface for all graph visitors. Using on the graph exploration method, the
  18  * visit methods will be called for each vertex and edge visited
  19  */
  20 public interface ITmfGraphVisitor {
  21
  22     /**
  23      * Visits a vertex that is the head of a worker streak. The head here is not
  24      * the first node of an object. It is just a node with no edge going left.
  25      * An object may have many head vertices
  26      *
  27      * @param vertex
  28      *            The visited vertex
  29      */
  30     void visitHead(TmfVertex vertex);
  31
  32     /**
  33      * Visits a vertex
  34      *
  35      * @param vertex
  36      *            The visited vertex
  37      */
  38     void visit(TmfVertex vertex);
  39
  40     /**
  41      * Visits an edge
  42      *
  43      * @param edge
  44      *            The visited edge
  45      * @param horizontal
  46      *            Whether the edge is horizontal (beginning and end are of the
  47      *            same worker) or vertical
  48      */
  49     void visit(TmfEdge edge, boolean horizontal);
  50
  51 }