jadex.quickstart.cleanerworld.environment.ICleaner Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jadex-applications-quickstart Show documentation

The Jadex quickstart package contains the ready to use "Cleanerworld" environment as a testbed for experimenting with autonomous agents and intelligent behavior.

There is a newer version: 4.0.267

Show newest version

package jadex.quickstart.cleanerworld.environment;

import jadex.bridge.IComponentIdentifier;

/**
 *  Cleaner object represents knowledge about a cleaner robot.
 */
public interface ICleaner	extends ILocationObject
{
	/**
	 *  Get the id (or name) of this object.
	 *  @return The id.
	 */
	public String getId();

	/**
	 *  Get the location of this object.
	 * @return The location of the object.
	 */
	public ILocation getLocation();

	/**
	 *  Get the chargestate of this Cleaner.
	 * @return Charge state of the battery (0.0-1.0).
	 */
	public double getChargestate();
	
	/**
	 *  Get the carried-waste of this Cleaner.
	 * @return The carried waste, if any.
	 */
	public IWaste getCarriedWaste();

	/**
	 *  Get the vision-range of this Cleaner.
	 * @return The distance that this cleaner is able to see.
	 */
	public double getVisionRange();

	/**
	 *  Get the identifier (address) of the cleaner
	 *  @return The identifier that can be used to send a message to the cleaner.
	 */
	public IComponentIdentifier getAgentIdentifier();
}