org.arl.fjage

Class Platform

java.lang.Object

org.arl.fjage.Platform

All Implemented Interfaces:

TimestampProvider

Direct Known Subclasses:

DiscreteEventSimulator, RealTimePlatform

public abstract class Platform
extends java.lang.Object
implements TimestampProvider

Base class for platforms on which agent containers run. The platform provides basic system functionality such as timing, network, etc.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Container>	containers
protected boolean	running

Constructor Summary

Constructors

Constructor and Description
Platform()

Method Summary

Modifier and Type	Method and Description
void	addContainer(Container container) Adds a container to the platform.
abstract long	currentTimeMillis() Gets the current platform time in milliseconds.
abstract void	delay(long millis) Delays execution by a specified number of milliseconds of platform time.
static java.lang.String	getBuildVersion() Get build version information from JAR.
Container[]	getContainers() Gets all the containers on the platform.
java.lang.String	getHostname() Gets the hostname for the platform.
java.net.NetworkInterface	getNetworkInterface() Gets a network interface that the platform is bound to.
abstract void	idle() Internal method called by a container when all agents are idle.
boolean	isIdle() Check if all containers on the platform are idle.
boolean	isRunning() Check if any container on the platform is running.
abstract long	nanoTime() Gets the current platform time in nanoseconds.
abstract void	schedule(java.util.TimerTask task, long millis) Schedules a task to be executed at a given platform time.
void	setHostname(java.lang.String hostname) Sets the hostname for the platform.
void	setNetworkInterface(java.net.NetworkInterface nif) Sets the network interface to bind to.
void	setNetworkInterface(java.lang.String name) Sets the network interface to bind to.
void	shutdown() Terminates all containers on the platform.
void	start() Starts all containers on the platform.

Methods inherited from class java.lang.Object

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

Field Detail

containers

protected java.util.List<Container> containers

running

protected boolean running

Constructor Detail

Platform

public Platform()

Method Detail

currentTimeMillis

public abstract long currentTimeMillis()

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

Returns:

time in milliseconds.

nanoTime

public abstract long nanoTime()

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

Returns:

time in nanoseconds.

schedule

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

Schedules a task to be executed at a given platform time.

Parameters:

task - task to be executed.

millis - time at which to execute the task.

idle

public abstract void idle()

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

delay

public abstract void delay(long millis)

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.

Parameters:

millis - number of milliseconds to delay execution.

addContainer

public void addContainer(Container container)

Adds a container to the platform. This method is typically called automatically by containers when they are created.

Parameters:

container - the container.

getContainers

public Container[] getContainers()

Gets all the containers on the platform.

Returns:

an array of containers.

start

public void start()

Starts all containers on the platform.

shutdown

public void shutdown()

Terminates all containers on the platform.

setHostname

public void setHostname(java.lang.String hostname)

Sets the hostname for the platform.

Parameters:

hostname - name of the host.

See Also:

getHostname()

getHostname

public java.lang.String getHostname()

Gets the hostname for the platform. If the hostname is not set or set to null, it is automatically determined from the Internet hostname for the machine.

Returns:

the name of the host.

getNetworkInterface

public java.net.NetworkInterface getNetworkInterface()

Gets a network interface that the platform is bound to.

Returns:

bound network interface, null if no binding.

setNetworkInterface

public void setNetworkInterface(java.lang.String name)
                         throws java.net.SocketException

Sets the network interface to bind to.

Parameters:

name - name of the network interface.

Throws:

java.net.SocketException

setNetworkInterface

public void setNetworkInterface(java.net.NetworkInterface nif)

Sets the network interface to bind to.

Parameters:

nif - network interface.

isRunning

public boolean isRunning()

Check if any container on the platform is running.

Returns:

true if a container is running, false otherwise.

isIdle

public boolean isIdle()

Check if all containers on the platform are idle.

Returns:

true if all containers are idle, false otherwise.

getBuildVersion

public static java.lang.String getBuildVersion()

Get build version information from JAR.

Returns:

build version information string.