package aima.core.learning.reinforcement.example;

import aima.core.environment.cellworld.Cell;
import aima.core.learning.reinforcement.PerceptStateReward;

/**
 * An implementation of the PerceptStateReward interface for the cell world
 * environment. Note: The getCell() and setCell() methods allow a single percept
 * to be instantiated per agent within the environment. However, if an agent
 * tracks its perceived percepts it will need to explicitly copy the relevant
 * information.
 * 
 * @author oreilly
 * 
 */
public class CellWorldPercept implements PerceptStateReward<Cell<Double>> {
	private Cell<Double> cell = null;

	/**
	 * Constructor.
	 * 
	 * @param cell
	 *            the cell within the environment that the percept refers to.
	 */
	public CellWorldPercept(Cell<Double> cell) {
		this.cell = cell;
	}

	/**
	 * 
	 * @return the cell within the environment that the percept refers to.
	 */
	public Cell<Double> getCell() {
		return cell;
	}

	/**
	 * Set the cell within the environment that the percept refers to.
	 * 
	 * @param cell
	 *            the cell within the environment that the percept refers to.
	 */
	public void setCell(Cell<Double> cell) {
		this.cell = cell;
	}

	//
	// START-PerceptStateReward

	@Override
	public double reward() {
		return cell.getContent().doubleValue();
	}

	@Override
	public Cell<Double> state() {
		return cell;
	}

	// END-PerceptStateReward
	//
}