Simulation.java

package jamel.util;

import java.io.File;
import java.util.Random;

import org.jfree.data.xy.XYSeries;

import jamel.data.Expression;

/**
 * Represents a simulation.
 */
public interface Simulation {

	/**
	 * Returns an expression that provides access to the specified simulation
	 * data.
	 * 
	 * @param key
	 *            the description of the data to be returned.
	 * @return an expression that provides access to the specified simulation
	 *         data.
	 */
	Expression getDataAccess(String key);

	/**
	 * Returns the specified numerical expression.
	 * 
	 * @param key
	 *            the description of the expression to be returned.
	 * @return the specified numerical expression.
	 */
	Expression getExpression(String key);

	/**
	 * Returns the scenario file of this simulation.
	 * 
	 * @return the scenario file of this simulation.
	 */
	File getFile();

	/**
	 * Returns the name of the simulation.
	 * 
	 * @return the name of the simulation.
	 */
	String getName();

	/**
	 * Returns the value of the current period.
	 * 
	 * @return the value of the current period.
	 */
	int getPeriod();

	/**
	 * Returns the random.
	 * 
	 * @return the random.
	 */
	Random getRandom();

	/**
	 * Returns the specified sector.
	 * 
	 * @param name
	 *            the name of the sector to be returned.
	 * @return the specified sector.
	 */
	Sector getSector(String name);

	/**
	 * Returns the specified series.
	 * 
	 * @param x
	 *            the description of x values.
	 * @param y
	 *            the description of y values.
	 * @return the specified series.
	 */
	XYSeries getSeries(String x, String y);

	/**
	 * Returns <code>true</code> if this simulation is paused,
	 * <code>false</code> otherwise.
	 * 
	 * @return <code>true</code> if this simulation is paused,
	 *         <code>false</code> otherwise.
	 */
	boolean isPaused();

	/**
	 * Pauses or resumes the simulation.
	 */
	void pause();

	/**
	 * Runs the simulation.
	 */
	void run();

}