org.arakhne.tinyMAS.core

Class Kernel<AT extends Agent,ET extends Environment<AT>,YP extends YellowPages,MTS extends MessageTransportService>

java.lang.Object

org.arakhne.tinyMAS.core.Kernel<AT,ET,YP,MTS>

Type Parameters:

AT - is the type of agent supported by this kernel

ET - is the type of environment supported by this kernel

YP - is the type of yellow page supported by this kernel

MTS - is the type of message transport service supported by this kernel.

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

Game, Game, Game, NetworkKernel

Deprecated.

See "http://www.janus-project.org"

@Deprecated
public class Kernel<AT extends Agent,ET extends Environment<AT>,YP extends YellowPages,MTS extends MessageTransportService>
extends Object
implements Runnable

Kernel of the TinyMAS application.

The kernel is the central point of the multiagent platform.

Author:

Stéphane GALLAND <galland@arakhne.org>, Nicolas GAUD <nicolas.gaud@utbm.fr>

Field Summary

Fields

Modifier and Type	Field and Description
static int	KERNEL_STOP_TIMEOUT Deprecated. Timeout in milliseconds to wait about kernel stop.
static int	TIME_PRECISION Deprecated. This is the minimal duration which can be measured by an operating system (in milliseconds).

Constructor Summary

Constructors

Constructor and Description
Kernel() Deprecated. Create a kernel with the default components.
Kernel(ET env) Deprecated. Create a kernel with the specified components.
Kernel(MTS mts, Scheduler<AT> scheduler) Deprecated. Create a kernel with the specified scheduler and message transport service.
Kernel(MTS mts, WhitePages<AT> whitepages, YP yellowpages) Deprecated. Create a kernel with the specified components.
Kernel(MTS mts, WhitePages<AT> whitepages, YP yellowpages, Scheduler<AT> scheduler) Deprecated. Create a kernel with the specified components.
Kernel(MTS mts, WhitePages<AT> whitepages, YP yellowpages, Scheduler<AT> scheduler, ET env) Deprecated. Create a kernel with the specified components.
Kernel(MTS mts, YP yellowpages) Deprecated. Create a kernel with the specified components.
Kernel(MTS mts, YP yellowpages, Scheduler<AT> scheduler) Deprecated. Create a kernel with the specified components.
Kernel(Scheduler<AT> scheduler) Deprecated. Create a kernel with the specified scheduler.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAgent(Agent agent) Deprecated. Add an agent inside this kernel.
void	addAgent(AgentIdentifier id, AT a) Deprecated. Add an agent inside this kernel.
void	addKernelListener(KernelListener listener) Deprecated. Add a listener.
protected static void	displayKernelMessage(String msg) Deprecated. Kernel log.
long	getAgentCount() Deprecated. Replies the count of agents registered inside this kernel.
(package private) AgentIdentifier	getAgentId(AT a) Deprecated. Replies the identifier of the specified agent.
ET	getEnvironment() Deprecated. Replies the environment used by this kernel (if it exist).
KernelIdentifier	getKernelId() Deprecated. Replies the identifier of this kernel.
long	getKernelStep() Deprecated. Replies the count of simulation turns since the start of the kernel.
long	getKernelStepDuration() Deprecated. Replies the duration in milliseconds of one turn of the kernel.
(package private) MTS	getMTS() Deprecated. Replies the message transport service used by this kernel.
Probe	getProbe(AgentIdentifier agentId) Deprecated. Replies a probe on the specified agent.
AgentIdentifier[]	getServiceProviders(String serviceName) Deprecated. Replies the list of agents that provide the specified service
SimulationClock	getSimulationClock() Deprecated. Replies the simulation clock associated to this kernel.
static Kernel<?,?,?,?>	getSingleton() Deprecated. Replies the unique instance of Kernel.
YP	getYellowPageSystem() Deprecated. Replies the yellow pages used by this kernel.
boolean	isOnThisKernel(AgentIdentifier agent) Deprecated. Replies if this agent identifier corresponds to an agent inside this kernel.
boolean	isShutdown() Deprecated. Replies if this kernel was launch, but is now shutdown.
boolean	isStopped() Deprecated. Replies if the kernel is not running.
boolean	isUnderPause() Deprecated. Replies if this kernel is under pause.
(package private) void	killAgent(AgentIdentifier id) Deprecated. Kill an agent.
void	pause() Deprecated. Push the current kernel under pause.
static void	pauseKernel() Deprecated. Push the singleton kernel under pause.
static Probe	probe(AgentIdentifier agentId) Deprecated. Replies a probe on the specified agent.
boolean	registerAsSingleton() Deprecated. Register this kernel as the singleton.
(package private) void	removeAgent(AgentIdentifier id) Deprecated. Kill an agent.
(package private) void	removeAllAgents() Deprecated. Kill immediately all the agents.
void	removeKernelListener(KernelListener listener) Deprecated. remove a listener.
void	run() Deprecated. Run the kernel.
protected void	runAgentLifeStage() Deprecated. Run the agent live stages.
protected void	runInitializationStage() Deprecated. Run the initialization stage of the kernel.
protected void	runShutdownStage() Deprecated. run the shutdown stage of the kernel.
static AgentIdentifier[]	service(String serviceName) Deprecated. Replies the list of agents that provide the specified service
void	setEnvironment(ET env) Deprecated. Set the environment that should be used by this kernel.
void	setWaitingDuration(int duration) Deprecated. Set the milliseconds to wait between two simulation steps.
protected void	startAgents(Collection<AT> agents) Deprecated. Agent lif-cycle: starts all the specified agents.
void	stop() Deprecated. Stop the kernel.
protected void	stopAgents(Collection<AT> agents) Deprecated. Notify of the specified agents that they are dead.
static void	stopKernel() Deprecated. Stop the kernel singleton.

Methods inherited from class java.lang.Object

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

Field Detail

TIME_PRECISION

public static final int TIME_PRECISION

Deprecated.

This is the minimal duration which can be measured by an operating system (in milliseconds).

See Also:

Constant Field Values

KERNEL_STOP_TIMEOUT

public static final int KERNEL_STOP_TIMEOUT

Deprecated.

Timeout in milliseconds to wait about kernel stop.

See Also:

Constant Field Values

Constructor Detail

Kernel

public Kernel()

Deprecated.

Create a kernel with the default components.

Kernel

public Kernel(Scheduler<AT> scheduler)

Deprecated.

Create a kernel with the specified scheduler.

Parameters:

scheduler -

Kernel

public Kernel(MTS mts,
      Scheduler<AT> scheduler)

Deprecated.

Create a kernel with the specified scheduler and message transport service.

Parameters:

mts -

scheduler -

Kernel

public Kernel(MTS mts,
      WhitePages<AT> whitepages,
      YP yellowpages)

Deprecated.

Create a kernel with the specified components.

Parameters:

mts -

whitepages -

yellowpages -

Kernel

public Kernel(MTS mts,
      YP yellowpages)

Deprecated.

Create a kernel with the specified components.

Parameters:

mts -

yellowpages -

Kernel

public Kernel(MTS mts,
      WhitePages<AT> whitepages,
      YP yellowpages,
      Scheduler<AT> scheduler)

Deprecated.

Create a kernel with the specified components.

Parameters:

mts -

whitepages -

yellowpages -

scheduler -

Kernel

public Kernel(MTS mts,
      YP yellowpages,
      Scheduler<AT> scheduler)

Deprecated.

Create a kernel with the specified components.

Parameters:

mts -

yellowpages -

scheduler -

Kernel

public Kernel(ET env)

Deprecated.

Create a kernel with the specified components.

Parameters:

env -

Kernel

public Kernel(MTS mts,
      WhitePages<AT> whitepages,
      YP yellowpages,
      Scheduler<AT> scheduler,
      ET env)

Deprecated.

Create a kernel with the specified components.

Parameters:

mts -

whitepages -

yellowpages -

scheduler -

env -

Method Detail

getSingleton

public static Kernel<?,?,?,?> getSingleton()

Deprecated.

Replies the unique instance of Kernel.

Returns:

the singleton

See Also:

registerAsSingleton()

registerAsSingleton

public boolean registerAsSingleton()

Deprecated.

Register this kernel as the singleton.

Returns:

true if this kernel is now the singleton, otherwise false

See Also:

getSingleton()

getMTS

MTS getMTS()

Deprecated.

Replies the message transport service used by this kernel.

Returns:

the MTS

getEnvironment

public ET getEnvironment()

Deprecated.

Replies the environment used by this kernel (if it exist).

Returns:

the environment

setEnvironment

public void setEnvironment(ET env)

Deprecated.

Set the environment that should be used by this kernel.

Parameters:

env -

addAgent

public void addAgent(Agent agent)

Deprecated.

Add an agent inside this kernel.

The kernel assumes that the specified agent was never spawn before. An unique identifier will be provided to the specified agent.

Parameters:

agent -

addAgent

public void addAgent(AgentIdentifier id,
            AT a)

Deprecated.

Add an agent inside this kernel.

The kernel assumes that the specified agent was already spawn before. The specified identifier will be given to the agent (if it is unique).

Parameters:

id -

a -

killAgent

void killAgent(AgentIdentifier id)

Deprecated.

Kill an agent.

This method should only be invoked by Agent.killMe().

The agent will be removed at the end of the current scheduling step.

Parameters:

id -

See Also:

removeAgent(AgentIdentifier)

removeAgent

void removeAgent(AgentIdentifier id)

Deprecated.

Kill an agent.

The agent will be removed immediately.

Parameters:

id -

See Also:

killAgent(AgentIdentifier)

removeAllAgents

void removeAllAgents()

Deprecated.

Kill immediately all the agents.

getAgentId

AgentIdentifier getAgentId(AT a)

Deprecated.

Replies the identifier of the specified agent.

Parameters:

a -

Returns:

the identifier.

run

public void run()

Deprecated.

Run the kernel.

This method invokes:

• runInitializationStage()
• runAgentLifeStage()
• runShutdownStage()

Specified by:

run in interface Runnable

See Also:

runInitializationStage(), runAgentLifeStage(), runShutdownStage()

runInitializationStage

protected void runInitializationStage()

Deprecated.

Run the initialization stage of the kernel.

See Also:

run(), runAgentLifeStage(), runShutdownStage()

runAgentLifeStage

protected void runAgentLifeStage()

Deprecated.

Run the agent live stages.

See Also:

run(), runInitializationStage(), runShutdownStage()

runShutdownStage

protected void runShutdownStage()

Deprecated.

run the shutdown stage of the kernel.

See Also:

run(), runInitializationStage(), runAgentLifeStage()

startAgents

protected void startAgents(Collection<AT> agents)

Deprecated.

Agent lif-cycle: starts all the specified agents.

Parameters:

agents -

setWaitingDuration

public void setWaitingDuration(int duration)

Deprecated.

Set the milliseconds to wait between two simulation steps.

Parameters:

duration -

stopAgents

protected void stopAgents(Collection<AT> agents)

Deprecated.

Notify of the specified agents that they are dead.

Parameters:

agents -

isStopped

public boolean isStopped()

Deprecated.

Replies if the kernel is not running. If the kernel is under pause, this function replies true

Returns:

true if the kernel was stopped, otherwise false

isUnderPause

public boolean isUnderPause()

Deprecated.

Replies if this kernel is under pause.

Returns:

true if the kernel was paused, otherwise false

isShutdown

public boolean isShutdown()

Deprecated.

Replies if this kernel was launch, but is now shutdown.

Returns:

true if the kernel was shutdown, otherwise false

stop

public void stop()

Deprecated.

Stop the kernel.

stopKernel

public static void stopKernel()

Deprecated.

Stop the kernel singleton.

pause

public void pause()

Deprecated.

Push the current kernel under pause.

pauseKernel

public static void pauseKernel()

Deprecated.

Push the singleton kernel under pause.

probe

public static Probe probe(AgentIdentifier agentId)

Deprecated.

Replies a probe on the specified agent.

Parameters:

agentId -

Returns:

a probe or null if the agent could not provide a probe.

service

public static AgentIdentifier[] service(String serviceName)

Deprecated.

Replies the list of agents that provide the specified service

Parameters:

serviceName -

Returns:

the list of providers.

getKernelId

public KernelIdentifier getKernelId()

Deprecated.

Replies the identifier of this kernel.

Returns:

the kernel identifier

getYellowPageSystem

public YP getYellowPageSystem()

Deprecated.

Replies the yellow pages used by this kernel.

Returns:

the yellow pages

getServiceProviders

public AgentIdentifier[] getServiceProviders(String serviceName)

Deprecated.

Replies the list of agents that provide the specified service

Parameters:

serviceName -

Returns:

the providers

getAgentCount

public long getAgentCount()

Deprecated.

Replies the count of agents registered inside this kernel.

Returns:

the count of agents.

isOnThisKernel

public boolean isOnThisKernel(AgentIdentifier agent)

Deprecated.

Replies if this agent identifier corresponds to an agent inside this kernel.

Parameters:

agent -

Returns:

true if the given agent is on this kernel, otherwise false

displayKernelMessage

protected static void displayKernelMessage(String msg)

Deprecated.

Kernel log.

Parameters:

msg -

getKernelStep

public long getKernelStep()

Deprecated.

Replies the count of simulation turns since the start of the kernel.

Returns:

the count of turns

getKernelStepDuration

public long getKernelStepDuration()

Deprecated.

Replies the duration in milliseconds of one turn of the kernel.

Returns:

the duration of a turn.

getSimulationClock

public SimulationClock getSimulationClock()

Deprecated.

Replies the simulation clock associated to this kernel.

This function replies the clock of the environment if it exists or an internal clock based on the kernel steps.

Returns:

never null

See Also:

getKernelStep(), getKernelStepDuration()

addKernelListener

public void addKernelListener(KernelListener listener)

Deprecated.

Add a listener.

Parameters:

listener -

removeKernelListener

public void removeKernelListener(KernelListener listener)

Deprecated.

remove a listener.

Parameters:

listener -

getProbe

public Probe getProbe(AgentIdentifier agentId)

Deprecated.

Replies a probe on the specified agent.

Parameters:

agentId -

Returns:

a probe or null if the agent could not provide a probe.