org.arl.fjage

Class TickerBehavior

java.lang.Object

org.arl.fjage.Behavior

org.arl.fjage.TickerBehavior

All Implemented Interfaces:

java.lang.Comparable<Behavior>

public class TickerBehavior
extends Behavior

A behavior that is executed every specified period. The onTick() method of this behavior is called at intervals defined by the period.

Field Summary

Fields inherited from class org.arl.fjage.Behavior

action, agent, log

Constructor Summary

Constructors

Constructor and Description
TickerBehavior(long millis) Creates a behavior that is executed every specified period.
TickerBehavior(long millis, java.lang.Runnable runnable) Creates a behavior that is executed every specified period.

Method Summary

Modifier and Type	Method and Description
void	action() This method calls onTick() once every specified period.
static TickerBehavior	create(long millis, java.lang.Runnable runnable) Creates a new TickerBehavior which runs the specified Runnable every specified period.
boolean	done() Returns true once stop() is called, false otherwise.
int	getPriority() This method should return a number that denotes the priority of a behavior.
int	getTickCount() Returns the number of times the onTick() method of this behavior has been called (including any ongoing call).
void	onStart() Computes the wakeup time for the first execution of this behavior.
void	onTick() This method is called once every specified period.
void	reset() Resets the behavior, allowing it to be used again.
void	stop() Terminates the behavior.

Methods inherited from class org.arl.fjage.Behavior

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TickerBehavior

public TickerBehavior(long millis)

Creates a behavior that is executed every specified period.

Parameters:

millis - period in milliseconds.

TickerBehavior

public TickerBehavior(long millis,
                      java.lang.Runnable runnable)

Creates a behavior that is executed every specified period.

Parameters:

millis - period in milliseconds.

runnable - Runnable to run.

Method Detail

stop

public final void stop()

Terminates the behavior.

getTickCount

public final int getTickCount()

Returns the number of times the onTick() method of this behavior has been called (including any ongoing call).

Returns:

the number of times the onTick() method has been called.

onTick

public void onTick()

This method is called once every specified period. The method is usually overridden by a behavior.

onStart

public void onStart()

Computes the wakeup time for the first execution of this behavior.

Overrides:

onStart in class Behavior

See Also:

Behavior.onStart()

action

public final void action()

This method calls onTick() once every specified period.

Overrides:

action in class Behavior

See Also:

Behavior.action()

done

public final boolean done()

Returns true once stop() is called, false otherwise.

Overrides:

done in class Behavior

Returns:

true once stop() is called, false otherwise.

See Also:

Behavior.done()

reset

public void reset()

Resets the behavior, allowing it to be used again.

Overrides:

reset in class Behavior

See Also:

Behavior.reset()

getPriority

public int getPriority()

Description copied from class: Behavior

This method should return a number that denotes the priority of a behavior. By default, the priority is 0. Behaviors with lower priority values are executed before behaviors with higher priority values.

Overrides:

getPriority in class Behavior

Returns:

priority value

create

public static TickerBehavior create(long millis,
                                    java.lang.Runnable runnable)

Creates a new TickerBehavior which runs the specified Runnable every specified period.

Parameters:

millis - Period in milliseconds.

runnable - Runnable to run.

Returns:

TickerBehavior