Package rekit.util.state

Class TimeStateMachine

java.lang.Object

rekit.util.state.TimeStateMachine

public class TimeStateMachine
extends Object

Simple StateMachine that is meant to be extended or decorated to achieve state dependent behavior where every state has a fixed duration.

The method logicLoop() must be periodically called to be able to let the States check for its time to be up. For this cause, the State must supply a State.getTimerTime() as well as a State.getNextState().

Author:

Angelo Aracri

Field Summary

Fields

Modifier and Type	Field	Description
protected State	currentState	The State, the TimeStateMachine is currently in.

Constructor Summary

Constructors

Constructor	Description
TimeStateMachine(State initialState)	The constructor that initializes the TimeStateMachine with a given initialState.

Method Summary

Modifier and Type	Method	Description
State	getState()	Getter for the State the TimeStateMachine is currently the in.
void	logicLoop()	Method that must be periodically called in order to check for the States time to be up.
void	nextState()	Switches the State to the next as specified by State.getNextState().
protected void	nextState(State nextState)	More specific version of nextState() that enables for switching to a given State that must not necessarily be specified by the current States State.getNextState() or that can be used to alter the States before entering them..

Methods inherited from class java.lang.Object

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

Field Details

currentState

protected State currentState

The State, the TimeStateMachine is currently in.

Constructor Details

TimeStateMachine

public TimeStateMachine(State initialState)

The constructor that initializes the TimeStateMachine with a given initialState.

Parameters:

initialState - the initial State.

Method Details

logicLoop

public void logicLoop()

Method that must be periodically called in order to check for the States time to be up.

nextState

public void nextState()

Switches the State to the next as specified by State.getNextState().

Calls both the old States State.leave() as well as the new ones State.enter(TimeStateMachine parent).

nextState

protected void nextState(State nextState)

More specific version of nextState() that enables for switching to a given State that must not necessarily be specified by the current States State.getNextState() or that can be used to alter the States before entering them..

Parameters:

nextState - the new State to enter.

getState

public State getState()

Getter for the State the TimeStateMachine is currently the in.

Returns:

the current State.