tmf: Specify extended trace properties with an interface

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.ui / src / org / eclipse / linuxtools / internal / lttng2 / ui / views / control / dialogs / IEnableKernelEvents.java

/**********************************************************************
 * Copyright (c) 2012 Ericsson
 * 
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors: 
 *   Bernd Hufmann - Initial API and implementation
 **********************************************************************/
package org.eclipse.linuxtools.internal.lttng2.ui.views.control.dialogs;

import java.util.List;

/**
 * <p>
 * Interface for providing information about kernel events to be enabled.
 * </p>
 * 
 * @author Bernd Hufmann
 */
public interface IEnableKernelEvents {

    // ------------------------------------------------------------------------
    // Accessors
    // ------------------------------------------------------------------------
 
    /**
     * @return a flag whether the tracepoints shall be configured.
     */
    public boolean isTracepoints();
    
    /**
     * @return a flag indicating whether all tracepoints shall be enabled or not.
     */
    public boolean isAllTracePoints();

    /**
     * @return a flag whether the syscalls shall be configured.
     */
    public boolean isSysCalls();
    
    /**
     * @return a flag indicating whether syscalls shall be enabled or not.
     */
    public boolean isAllSysCalls();

    /**
     * @return a list of event names to be enabled.
     */
    public List<String> getEventNames();

    /**
     * @return a flag whether the dynamic probe shall be configured.
     */
    public boolean isDynamicProbe();
    
    /**
     * @return event name of the dynamic probe (or null if no dynamic probe).
     */
    public String getProbeEventName();

    /**
     * @return the dynamic probe (or null if no dynamic probe).
     */
    public String getProbeName();

    /**
     * @return a flag whether the dynamic function entry/return probe shall be configured.
     */
    public boolean isDynamicFunctionProbe();
    
    /**
     * @return event name of the dynamic function entry/exit probe (or null if no dynamic probe).
     */
    public String getFunctionEventName();

    /**
     * @return the dynamic function entry/exit probe (or null if no dynamic probe).
     */
    public String getFunction();

//    /**
//     * @return a flag whether events using wildcards should be enabled
//     */
//    public boolean isWildcard();
//
//    /**
//     * @return a wildcard 
//     */
//    public String getWildcard();
//
//    /**
//     * @return a flag whether events using log levels should be enabled 
//     */
//    public boolean isLogLevel();
//
//    /**
//     * @return a log level type (loglevel or loglevel-only)
//     */
//    public LogLevelType getLogLevelType();
//    
//    /**
//     * @return a log level
//     */
//    public TraceLogLevel getLogLevel();
//
//    /**
//     * @return a event name for the log level enable action
//     */
//    public String getLogLevelEventName();
   
}