org.arakhne.tinyMAS.core

Class Agent

java.lang.Object

org.arakhne.tinyMAS.core.Agent

All Implemented Interfaces:

Comparable<Agent>

Direct Known Subclasses:

MovableAgent, MovableAgent, SituatedAgent, WorldGrid, WorldGrid

Deprecated.

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

@Deprecated
public abstract class Agent
extends Object
implements Comparable<Agent>

Abstract class that represents an agent.

Author:

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

Constructor Summary

Constructors

Constructor and Description
Agent() Deprecated. Create an uninitialized agent.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clearProbes() Deprecated. Clear the probes.
int	compareTo(Agent a) Deprecated.
boolean	equals(Object o) Deprecated.
protected void	forceIdentifierStringRepresentation() Deprecated. Force the identifier of this agent to adopt the string representation of this agent.
protected void	forceIdentifierStringRepresentation(String str) Deprecated. Force the identifier of this agent to adopt the string representation of this agent.
AgentIdentifier	getId() Deprecated. Replies the identifier of the agent.
protected Message	getNextMessage() Deprecated. Replies the next message available for this agent.
Probe	getProbe() Deprecated. Replies a probe on this agent.
protected double	getSimulationStepDuration() Deprecated. Replies the duration in milliseconds of one turn of the simulation.
protected double	getSimulationStepDuration(TimeUnit desired_unit) Deprecated. Replies the duration of a simulation loop for this environment.
protected double	getSimulationTime() Deprecated. Replies the simulation times in milliseconds.
protected double	getSimulationTime(TimeUnit timeUnit) Deprecated. Replies the simulation times.
protected boolean	hasMessage() Deprecated. Replies if a message is available.
(package private) boolean	isAlive() Deprecated. Replies if this agent living.
protected void	killMe() Deprecated. The agent should invoke this method to kill itself.
abstract void	live() Deprecated. Notify the agent that it must run one step of its life.
protected double	perSecond(double quantity) Deprecated. Convert the specified quantity specified in something per second to the same quantity expressed in something per simulation turn.
protected void	registerService(String... services) Deprecated. Register this agent as a provider of the specified services.
protected void	removeAllProbes() Deprecated. Remove all the probes.
protected void	removeProbe(String probeName) Deprecated. Remove a probe.
protected boolean	sendMessage(AgentIdentifier to, Serializable content) Deprecated. Send a message to another agent.
(package private) void	setId(AgentIdentifier id) Deprecated. Set the agent's identifier of this agent.
protected void	setProbe(String probeName, Object value) Deprecated. Set value that could be probed by another entity.
void	start() Deprecated. Start the life of an agent.
(package private) void	start(AgentIdentifier id) Deprecated. Start the life of an agent.
void	stop() Deprecated. Invoked when the agent is dead and must deasappear.
protected void	unregisterService(String... services) Deprecated. Unregister this agent as a provider of the specified services.

Methods inherited from class java.lang.Object

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

Constructor Detail

Agent

public Agent()

Deprecated.

Create an uninitialized agent.

Method Detail

forceIdentifierStringRepresentation

protected void forceIdentifierStringRepresentation()

Deprecated.

Force the identifier of this agent to adopt the string representation of this agent.

See Also:

Object.toString()

forceIdentifierStringRepresentation

protected void forceIdentifierStringRepresentation(String str)

Deprecated.

Force the identifier of this agent to adopt the string representation of this agent.

getProbe

public Probe getProbe()

Deprecated.

Replies a probe on this agent.

Returns:

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

setProbe

protected void setProbe(String probeName,
            Object value)

Deprecated.

Set value that could be probed by another entity.

Parameters:

probeName - is the name of the value.

value - is the value that could be obtained by a probe user.

clearProbes

protected void clearProbes()

Deprecated.

Clear the probes.

removeProbe

protected void removeProbe(String probeName)

Deprecated.

Remove a probe.

removeAllProbes

protected void removeAllProbes()

Deprecated.

Remove all the probes.

compareTo

public int compareTo(Agent a)

Deprecated.

Specified by:

compareTo in interface Comparable<Agent>

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

getId

public final AgentIdentifier getId()

Deprecated.

Replies the identifier of the agent.

setId

void setId(AgentIdentifier id)

Deprecated.

Set the agent's identifier of this agent.

Parameters:

id - is the identifier computed by the kernel.

isAlive

boolean isAlive()

Deprecated.

Replies if this agent living.

start

final void start(AgentIdentifier id)

Deprecated.

Start the life of an agent.

This method must initialize the simulation's attributes of the agent.

Parameters:

id - is the identifier of the agent.

start

public void start()

Deprecated.

Start the life of an agent.

This method must initialize the simulation's attributes of the agent.

live

public abstract void live()

Deprecated.

Notify the agent that it must run one step of its life.

stop

public void stop()

Deprecated.

Invoked when the agent is dead and must deasappear.

This method is supposed to released any computer resource allocated by the agent.

sendMessage

protected final boolean sendMessage(AgentIdentifier to,
                  Serializable content)

Deprecated.

Send a message to another agent.

Parameters:

to - is the identifier of the message receiver.

content - is the content of the message.

Returns:

true if the message was send, otherwise false

getNextMessage

protected final Message getNextMessage()

Deprecated.

Replies the next message available for this agent.

Returns:

the message or null if none was available

hasMessage

protected final boolean hasMessage()

Deprecated.

Replies if a message is available.

killMe

protected final void killMe()

Deprecated.

The agent should invoke this method to kill itself.

getSimulationTime

protected final double getSimulationTime()

Deprecated.

Replies the simulation times in milliseconds.

getSimulationTime

protected final double getSimulationTime(TimeUnit timeUnit)

Deprecated.

Replies the simulation times.

getSimulationStepDuration

protected final double getSimulationStepDuration()

Deprecated.

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

getSimulationStepDuration

protected double getSimulationStepDuration(TimeUnit desired_unit)

Deprecated.

Replies the duration of a simulation loop for this environment.

Parameters:

desired_unit - indicates the unit to use

Returns:

the simulation's step time.

perSecond

protected double perSecond(double quantity)

Deprecated.

Convert the specified quantity specified in something per second to the same quantity expressed in something per simulation turn.

See Also:

getSimulationStepDuration(), getSimulationStepDuration(TimeUnit)

registerService

protected final void registerService(String... services)

Deprecated.

Register this agent as a provider of the specified services.

unregisterService

protected final void unregisterService(String... services)

Deprecated.

Unregister this agent as a provider of the specified services.