org.arl.fjage

Class RealTimePlatform

java.lang.Object

org.arl.fjage.Platform

org.arl.fjage.RealTimePlatform

All Implemented Interfaces:

TimestampProvider

public final class RealTimePlatform
extends Platform

A platform that runs the agents in its containers in real-time. The notion of time in this platform is that of elapsed time in the real world, and hence this is a suitable platform for most applications.

Typical use of this platform is shown below:

 import org.arl.fjage.*;

 Platform platform = new RealTimePlatform();
 Container container = new Container(platform);
 container.add("myAgent", new myAgent());         // add appropriate agents
 platform.start();
 

Field Summary

Fields inherited from class org.arl.fjage.Platform

containers, running

Constructor Summary

Constructors

Constructor and Description
RealTimePlatform()

Method Summary

Modifier and Type	Method and Description
long	currentTimeMillis() Gets the current platform time in milliseconds.
void	delay(long millis) Delays execution by a specified number of milliseconds of platform time.
void	idle() Internal method called by a container when all agents are idle.
long	nanoTime() Gets the current platform time in nanoseconds.
void	schedule(java.util.TimerTask task, long millis) Schedules a task to be executed after a given delay.

Methods inherited from class org.arl.fjage.Platform

addContainer, getBuildVersion, getContainers, getHostname, getNetworkInterface, isIdle, isRunning, setHostname, setNetworkInterface, setNetworkInterface, shutdown, start

Methods inherited from class java.lang.Object

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

Constructor Detail

RealTimePlatform

public RealTimePlatform()

Method Detail

currentTimeMillis

public long currentTimeMillis()

Description copied from class: Platform

Gets the current platform time in milliseconds. For real-time platforms, this time is epoch time. For simulation platforms, this time is simulation time.

Specified by:

currentTimeMillis in interface TimestampProvider

Specified by:

currentTimeMillis in class Platform

Returns:

time in milliseconds.

nanoTime

public long nanoTime()

Description copied from class: Platform

Gets the current platform time in nanoseconds. For real-time platforms, this time is epoch time. For simulation platforms, this time is simulation time. This time is nanosecond precision, but not necessarily nanosecond accuracy.

Specified by:

nanoTime in interface TimestampProvider

Specified by:

nanoTime in class Platform

Returns:

time in nanoseconds.

schedule

public void schedule(java.util.TimerTask task,
                     long millis)

Description copied from class: Platform

Schedules a task to be executed after a given delay. A non-positive delay causes the task to be executed as soon as possible.

Specified by:

schedule in class Platform

Parameters:

task - task to be executed.

millis - delay in milliseconds after which to execute the task.

idle

public void idle()

Description copied from class: Platform

Internal method called by a container when all agents are idle.

Specified by:

idle in class Platform

delay

public void delay(long millis)

Description copied from class: Platform

Delays execution by a specified number of milliseconds of platform time.

This method should not be called by an agent directly, as it may deadlock. An agent should use Agent.delay(long) instead.

Specified by:

delay in class Platform

Parameters:

millis - number of milliseconds to delay execution.