package ie.dcu.auto.automator;

/**
 * Automates the evaluation of interactive segmentation algorithms
 * 
 * @author Kevin McGuinness
 */
public interface Automator {

	/**
	 * The maximum brush size that an automator may use.
	 */
	public static final int MAX_BRUSH_SIZE = 20;
	
	/**
	 * The default maximum number of steps to use.
	 */
	public static final int DEFAULT_MAX_STEPS = 200;

	/**
	 * Returns the current step.
	 */
	public int getStep();

	/**
	 * Returns the max number of steps the automator will take.
	 */
	public int getMaxSteps();

	/**
	 * Set the max number of steps the automator will take.
	 */
	public void setMaxSteps(int maxSteps);

	/**
	 * Returns true if the automator can currently be reset.
	 */
	public boolean canReset();

	/**
	 * Reset the automator.
	 */
	public void reset();

	/**
	 * Returns true if the automator can currently be started.
	 */
	public boolean canStart();

	/**
	 * Start the automator.
	 */
	public void start();

	/**
	 * Returns true if a step in the automation can be taken.
	 */
	public boolean canStep();

	/**
	 * Take the next step in the automation procedure.
	 */
	public void step();
}