org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/synchronization/SynchronizationAlgorithmFactory.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014 École Polytechnique de Montréal
   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
  13 package org.eclipse.tracecompass.tmf.core.synchronization;
  14
  15 import org.eclipse.tracecompass.internal.tmf.core.synchronization.SyncAlgorithmFullyIncremental;
  16
  17 /**
  18  * A factory to generate synchronization algorithm to synchronize traces
  19  *
  20  * @author Geneviève Bastien
  21  * @since 3.2
  22  */
  23 public final class SynchronizationAlgorithmFactory {
  24
  25     private SynchronizationAlgorithmFactory() {
  26
  27     }
  28
  29     /**
  30      * Returns the system's default trace synchronization algorithm, ie the
  31      * fully incremental convex hull synchronization algorithm.
  32      *
  33      * @return The default trace synchronization algorithm
  34      */
  35     public static SynchronizationAlgorithm getDefaultAlgorithm() {
  36         return new SyncAlgorithmFullyIncremental();
  37     }
  38
  39     /**
  40      * Returns the class implementing the fully incremental convex hull trace
  41      * synchronization approach as described in
  42      *
  43      * Masoume Jabbarifar, Michel Dagenais and Alireza Shameli-Sendi,
  44      * "Streaming Mode Incremental Clock Synchronization"
  45      *
  46      * @return The {@link SynchronizationAlgorithm} implementing the fully
  47      *         incremental convex hull synchronization algorithm
  48      */
  49     public static SynchronizationAlgorithm getFullyIncrementalAlgorithm() {
  50         return new SyncAlgorithmFullyIncremental();
  51     }
  52 }