iRobotCreate

Class IRobotState

java.lang.Object

iRobotCreate.IRobotState

public abstract class IRobotState
extends Object

A base class for State objects, having a #handleEvent(Sensor, short) method. method.

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
private String	name

Constructor Summary

Constructors

Constructor and Description
IRobotState(String name) Automatically puts the state into the StateBasedController.allStates structure.

Method Summary

Modifier and Type	Method and Description
void	enterState() This method is called each time the state is set (so can be called multiple times).
String	getName()
abstract void	handleEvent(iRobotCommands.Sensor sensor, short reading) Abstract class to be overridden by each concrete state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

private String name

Constructor Detail

IRobotState

public IRobotState(String name)

Automatically puts the state into the StateBasedController.allStates structure.

Parameters:

name -

Method Detail

handleEvent

public abstract void handleEvent(iRobotCommands.Sensor sensor,
                                 short reading)

Abstract class to be overridden by each concrete state.

Parameters:

sensor -

reading -

enterState

public void enterState()

This method is called each time the state is set (so can be called multiple times). This version does nothing; override it if you need state initialization.

getName

public String getName()

Returns:

the name of the state.