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