debug/org.eclipse.ptp.debug.core/pdi/org/eclipse/ptp/debug/core/pdi/event/IPDISignalInfo.java

/*******************************************************************************
 * Copyright (c) 2005 The Regents of the University of California. 
 * This material was produced under U.S. Government contract W-7405-ENG-36 
 * for Los Alamos National Laboratory, which is operated by the University 
 * of California for the U.S. Department of Energy. The U.S. Government has 
 * rights to use, reproduce, and distribute this software. NEITHER THE 
 * GOVERNMENT NOR THE UNIVERSITY MAKES ANY WARRANTY, EXPRESS OR IMPLIED, OR 
 * ASSUMES ANY LIABILITY FOR THE USE OF THIS SOFTWARE. If software is modified 
 * to produce derivative works, such modified software should be clearly marked, 
 * so as not to confuse it with the version available from LANL.
 * 
 * Additionally, 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
 * 
 * LA-CC 04-115
 *******************************************************************************/
package org.eclipse.ptp.debug.core.pdi.event;

import org.eclipse.ptp.debug.core.pdi.IPDILocator;
import org.eclipse.ptp.debug.core.pdi.IPDISessionObject;
import org.eclipse.ptp.debug.core.pdi.model.IPDISignal;

/**
 * Represents signal info
 * @author clement
 *
 */
public interface IPDISignalInfo extends IPDISessionObject {
	/**
	 * Returns signal name
	 * @return signal name
	 */
	String getName();
	
	/**
	 * Returns signal
	 * @return signal - can be null
	 */
	IPDISignal getSignal();
	
	/**
	 * Returns signal description
	 * @return String signal description
	 */
	String getDescription();
	
	/**
	 * Returns the location of this signal
	 * @return location of this signal - can be null
	 */
	IPDILocator getLocator();
}