org.arl.fjage

Class FSMBehavior

java.lang.Object

org.arl.fjage.Behavior

org.arl.fjage.FSMBehavior

All Implemented Interfaces:

java.lang.Comparable<Behavior>

public class FSMBehavior
extends Behavior

Finite state machine (FSM) behavior. This behavior implements a simple FSM with cyclic behavior-like states.

An example FSM is shown below:

 FSMBehavior fsm = new FSMBehavior();
 fsm.add(new FSMBehavior.State("state1") {
   public void action() {
     log.info("In State #1");
     setNextState("state2");
   }
 });
 fsm.add(new FSMBehavior.State("state2") {
   public void action() {
     log.info("In State #2");
     terminate();
   }
 });
 agent.add(fsm);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FSMBehavior.State FSM state behavior.

Field Summary

Fields inherited from class org.arl.fjage.Behavior

action, agent, log

Constructor Summary

Constructors

Constructor and Description
FSMBehavior() Creates a FSM behavior.
FSMBehavior(FSMBehavior.State... states) Creates a FSM behavior.

Method Summary

Modifier and Type	Method and Description
void	action() This method is repeatedly called during the life of a behavior.
void	add(FSMBehavior.State state) Adds a state to the FSM.
void	clear() Clears the FSM states.
boolean	done() This method should return true if the behavior is completed, false otherwise.
java.lang.Object	getCurrentState() Gets the current state name.
void	reenterState() Request re-entry of the current state in the FSM.
void	reset() Resets the FSM.
void	setInitialState(java.lang.Object name) Sets the initial state to start FSM in.
void	setNextState(java.lang.Object name) Sets the next state of the FSM.
void	terminate() Terminates the FSM by setting the next state to be FINAL.
void	trigger(java.lang.Object event) Trigger an event on the FSM.
void	trigger(java.lang.Object event, java.lang.Object eventInfo) Trigger an event on the FSM.

Methods inherited from class org.arl.fjage.Behavior

agent, agentForService, agentForService, agentsForService, agentsForService, block, block, compareTo, getPriority, isBlocked, onEnd, onStart, println, restart

Methods inherited from class java.lang.Object

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

Constructor Detail

FSMBehavior

public FSMBehavior()

Creates a FSM behavior.

FSMBehavior

public FSMBehavior(FSMBehavior.State... states)

Creates a FSM behavior.

Parameters:

states - States to be added to the FSM behavior.

Method Detail

action

public void action()

Description copied from class: Behavior

This method is repeatedly called during the life of a behavior. A behavior may override this to provide appropriate functionality.

Overrides:

action in class Behavior

done

public boolean done()

Description copied from class: Behavior

This method should return true if the behavior is completed, false otherwise. A behavior should override this.

Overrides:

done in class Behavior

Returns:

true if behavior is completed, false otherwise.

reset

public void reset()

Resets the FSM. If the FSM is running, the current state is discarded without FSMBehavior.State.onExit() being called. The states added to the FSM are retained.

Overrides:

reset in class Behavior

See Also:

Behavior.reset()

clear

public void clear()

Clears the FSM states. If the FSM is running, the current state is discarded without FSMBehavior.State.onExit() being called.

add

public void add(FSMBehavior.State state)

Adds a state to the FSM. The name of the state is taken from the state object. The first state added automatically becomes the initial state that the FSM starts in.

Parameters:

state - state behavior.

setInitialState

public void setInitialState(java.lang.Object name)

Sets the initial state to start FSM in. If this method is not called, the first state added to the FSM is assumed to be the initial state.

Parameters:

name - initial state object or name.

setNextState

public void setNextState(java.lang.Object name)

Sets the next state of the FSM.

Parameters:

name - name of the state.

reenterState

public void reenterState()

Request re-entry of the current state in the FSM. This causes the state to be exited, and re-entered.

getCurrentState

public java.lang.Object getCurrentState()

Gets the current state name.

Returns:

current state name.

terminate

public void terminate()

Terminates the FSM by setting the next state to be FINAL.

trigger

public void trigger(java.lang.Object event)

Trigger an event on the FSM.

Parameters:

event - an object naming the event.

trigger

public void trigger(java.lang.Object event,
                    java.lang.Object eventInfo)

Trigger an event on the FSM.

Parameters:

event - an object naming the event.

eventInfo - an object providing extra information on the event.