ProjektGraph/logging/LogElement.java

package logging;

import graph.DirectedGraph;
import graph.EdgeMarking;
import graph.VertexMarking;
import visualisation.HybridWindow;

/**
 * This class provides the basic log list element. 
 * Use it in assoziation with packages logging and visualization. 
 * It is used to store all relevant information about a algorithm processing'S single step. 
 * Extend it by the members you need. 
 * @see logging.Algorithm
 * @see logging.LogElementList
 * @see HybridWindow
 * @author Bj<EFBFBD>rn Strobel<br><small>
 * University of Cooperative Education Stuttgart, 
 * Campus Horb<br>
 * Department of Information Technology<br>
 * it2003<br></small>
 */
public abstract class LogElement {
	
	/** The step number of the single step within a algorithm's log element list.*/
	protected int step;
	/** Description of the single step's process.*/
	protected String description;

	/**
	 * Standard constructor.
	 * Creates a log element with step number 0 and "No description available." as description.
	 */
	public LogElement() {
		super();
		step=0;
		description="No description available.";
	}
	
	/**
	 * Creates a log element with the specified step number and description.
	 * @param step step number
	 * @param description step description
	 */
	public LogElement(int step,String description){
		this.step=step;
		this.description=description;
	}
	
	/**
	 * Returns the step's step number.
	 * @return the step's step number
	 */
	public int getStep(){
		return step;
	}
	
	/**
	 * Sets the step's step number.
	 * @param step the step's step number
	 */
	public void setStep(int step){
		this.step=step;
	}
	
	/**
	 * Returns the step's description.
	 * @return the step's description
	 */
	public String getDescription(){
		return description;
	}
	
	/**
	 * Sets the step's description.
	 * @param description the step's description
	 */
	public void setDescription(String description){
		this.description=description;
	}
}