org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/internal/tmf/core/statesystem/mipmap/ITmfMipmapFeature.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2014 Ericsson
   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  *     Jean-Christian Kouamé - Initial API and implementation
  11  *     Patrick Tasse - Updates to mipmap feature
  12  *******************************************************************************/
  13 package org.eclipse.tracecompass.internal.tmf.core.statesystem.mipmap;
  14
  15 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue;
  16
  17 /**
  18  * Interface to allow additional types of mipmaps to be added. Two functions
  19  * need to be implemented: {@link ITmfMipmapFeature#updateMipmap} and
  20  * {@link ITmfMipmapFeature#updateAndCloseMipmap}.
  21  *
  22  * @author Jean-Christian Kouamé
  23  *
  24  */
  25 public interface ITmfMipmapFeature {
  26
  27     /**
  28      * Update the mipmap with a new state value.
  29      *
  30      * @param value
  31      *            The new state value
  32      * @param ts
  33      *            The timestamp of the event
  34      */
  35     public void updateMipmap(ITmfStateValue value, long ts);
  36
  37     /**
  38      * Update the mipmap values at all levels before closing.
  39      */
  40     public void updateAndCloseMipmap();
  41 }