IExecutionToken.java

/*******************************************************************************
 * 	This file is part of Goko.
 *
 *   Goko is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   Goko is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General License for more details.
 *
 *   You should have received a copy of the GNU General License
 *   along with Goko.  If not, see <http://www.gnu.org/licenses/>.
 *******************************************************************************/
package org.goko.core.gcode.execution;

import java.util.List;

import org.goko.core.common.exception.GkException;
import org.goko.core.common.utils.IIdBean;
import org.goko.core.gcode.element.GCodeLine;
import org.goko.core.gcode.element.IGCodeProvider;
import org.goko.core.gcode.element.validation.IValidationTarget;

/**
 * A standard execution pattern
 * @author PsyKo
 *
 */
public interface IExecutionToken<T extends IExecutionTokenState> extends IIdBean, IValidationTarget {	
	
	/**
	 * Returns the GCode provider for this token
	 * @return the {@link IGCodeProvider}
	 */
	IGCodeProvider getGCodeProvider() throws GkException;
	
	/**
	 * Returns the execution order of this execution token
	 * @return the execution order
	 */
	int getExecutionOrder();
	
	/**
	 * Sets the execution order of this execution token
	 * @param order the execution order
	 */
	void setExecutionOrder(int order);
	
	/**
	 * Check if this execution token has more command
	 * @return <code>true</code> if there is more command, <code>false</code> otherwise
	 * @throws GkException GkException
	 */
	boolean hasMoreLine() throws GkException;
	
	/**
	 * Returns the total number of command
	 * @return the total number of command
	 * @throws GkException GkException
	 */
	int getLineCount() throws GkException;
	
	/**
	 * Returns the state of the given command
	 * @param idCommand the id of the command
	 * @throws GkException GkException
	 */
	T getLineState(Integer idLine) throws GkException;
	
	/**
	 * Returns the list of line in the given state 
	 * @param state the target state 
	 * @return a list of GCodeLine
	 * @throws GkException GkException
	 */
	List<GCodeLine> getLineByState(T state) throws GkException;
	
	/**
	 * Returns the count of line in the given state 
	 * @param state the target state 
	 * @return an integer
	 * @throws GkException GkException
	 */
	int getLineCountByState(T state) throws GkException;
	
	/**
	 * Sets the state of the given command 
	 * @param idCommand id of the command 
	 * @param state the state 
	 * @throws GkException GkException
	 */
	void setLineState(Integer idLine, T state) throws GkException;
	
	/**
	 * Returns (but does not remove) the next command to execute in this execution token
	 * @return a GCodeCommand
	 * @throws GkException GkException
	 */
	GCodeLine getNextLine() throws GkException;
	
	/**
	 * Returns (and remove) the next line to execute in this execution token
	 * @return a GCodeCommand
	 * @throws GkException GkException
	 */
	GCodeLine takeNextLine() throws GkException;
	
	/**
	 * Reset this token as it should be before the execution
	 * @throws GkException GkException
	 */
	void reset() throws GkException;
	
	/**
	 * Set the state of this token
	 * @param state the state to set
	 */
	void setState(ExecutionState state);
	
	/**
	 * Returns the state of this token
	 * @return the current state
	 */
	ExecutionState getState();
}