LampLightDetector.java

package lejos.robotics;

// TODO: This is wrong to have a lejos.robotics class using a lejos.nxt class.

/*
 * WARNING: THIS CLASS IS SHARED BETWEEN THE classes AND pccomms PROJECTS.
 * DO NOT EDIT THE VERSION IN pccomms AS IT WILL BE OVERWRITTEN WHEN THE PROJECT IS BUILT.
 */

/**
 * Interface for a light sensor that also includes a lamp (usually LED) to provide illumination.
 * @author BB
 *
 */
public interface LampLightDetector extends LightDetector {
// TODO: Possible names: LEDLightDetector (too specific), FloodlightDetector, FloodLightDetector, FloodlightLightDetector. 
	
	/**
	 * Turns the default LED light on or off. If the sensor has more than one lamp color, this will
	 * control the red LED.
	 * 
	 * @param floodlight true to turn on lamp, false for off (ambient light only).
	 */
	public void setFloodlight(boolean floodlight);
	
	/**
	 * Checks if the floodlight is currently on. 
	 * @return true if on, false if off.
	 */
	public boolean isFloodlightOn();
	
	/**
	 * Returns the color of the floodlight, including Color.NONE.
	 * @return An enumeration of the current color.
	 */
	public Colors.Color getFloodlight();
	
	/**
	 * Used to turn on or off the floodlight by color. If the sensor has multiple light colors, you can control
	 * which color is turned on or off. If the color does not exist, it does nothing and returns false.
	 * @param color Use {@link lejos.robotics.Color} enumeration constant to control lamp colors.
	 * @return True if lamp changed, false if lamp color doesn't exist for this sensor. 
	 */
	 
	public boolean setFloodlight(Colors.Color color);
	
}