agentgui.simulationService.agents

Class SimulationAgent

java.lang.Object

jade.core.Agent

agentgui.simulationService.agents.SimulationAgent

All Implemented Interfaces:

ServiceSensorInterface, jade.core.TimerListener, java.io.Serializable, java.lang.Runnable

Direct Known Subclasses:

AbstractDisplayAgent, ASynchTimeTestAgent

public abstract class SimulationAgent
extends jade.core.Agent
implements ServiceSensorInterface

This agent class can be used for simulations based on agents that are using the Agent.GUI SimulationService.

See Also:

SimulationService, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class jade.core.Agent

jade.core.Agent.Interrupted

Field Summary

Fields

Modifier and Type	Field and Description
protected EnvironmentModel	myEnvironmentModel The current EnvironmentModel.
protected ServiceSensor	mySensor The ServiceSensor of this agent.

Fields inherited from class jade.core.Agent

AP_ACTIVE, AP_DELETED, AP_IDLE, AP_INITIATED, AP_MAX, AP_MIN, AP_SUSPENDED, AP_WAITING, D_ACTIVE, D_MAX, D_MIN, D_RETIRED, D_SUSPENDED, D_UNKNOWN, MSG_QUEUE_CLASS

Constructor Summary

Constructors

Constructor and Description
SimulationAgent() Instantiates a new simulation agent as an active agent.
SimulationAgent(boolean passive) Instantiates a new simulation agent as a passive agent.

Method Summary

Modifier and Type	Method and Description
void	addSimulationServiceListener(ServiceSensorListener simulationServiceListener) Adds the simulation service listener.
protected void	afterClone()
protected void	afterMove()
protected void	beforeClone()
protected void	beforeMove()
protected void	checkAndActOnEnvironmentChanges() This Method checks if the environment changed in the meantime.
protected void	deregisterDFService() Unregisters a service for the agency to the DFService of JADE.
protected jade.domain.FIPAAgentManagement.DFAgentDescription[]	findAgentsByServiceType(java.lang.String serviceType) Find and returns agents by a service type.
protected EnvironmentModel	getEnvironmentModelFromSimulationService() Grab the environment model from the simulation service.
protected EnvironmentNotification	onEnvironmentNotification(EnvironmentNotification notification) This method will be executed if a ManagerNotification arrives this agent.
abstract void	onEnvironmentStimulus() This method is called if a stimulus from the outside reached this agent.
protected void	registerDFService(java.lang.String type, java.lang.String name, java.lang.String ownership) Registers a service for the agency to the DFService of JADE.
void	removeSimulationServiceListener(ServiceSensorListener simulationServiceListener) Removes the simulation service listener.
boolean	sendAgentNotification(jade.core.AID receiverAID, java.lang.Object notification) This method can be used to transfer any kind of information to one member of the current environment model.
void	sendDisplayAgentNotification(DisplayAgentNotification displayAgentNotification) Notify display agents about changes with a DisplayAgentNotification.
boolean	sendManagerNotification(java.lang.Object notification) This method can be used to transfer any kind of information to the Manager of the current environment model.
protected void	sensorPlugIn() This Method plugs IN the service sensor.
protected void	sensorPlugOut() This Method plugs OUT the service sensor.
void	setEnvironmentModel(EnvironmentModel envModel, boolean aSynchron) This method will be used by the ServiceActuator to inform this agent about changes in the environment.
protected void	setMyStimulusAnswer(java.lang.Object myNextState) This method sets the answer respectively the change of a single simulation agent back to the central simulation manager.
void	setNotification(EnvironmentNotification notification) This method can be invoked from the simulation service, if a notification for the manager has to be delivered.
protected void	setup()
protected void	takeDown()

Methods inherited from class jade.core.Agent

addBehaviour, blockingReceive, blockingReceive, blockingReceive, blockingReceive, changeStateTo, clean, createMessageQueue, doActivate, doClone, doDelete, doMove, doSuspend, doTimeOut, doWait, doWait, doWake, getAgentState, getAID, getAID, getAMS, getArguments, getBehavioursCnt, getBootProperties, getContainerController, getContentManager, getCurQueueSize, getDefaultDF, getExecutedBehavioursCnt, getHap, getHelper, getLocalName, getName, getO2AInterface, getO2AObject, getPostedMessagesCnt, getProperty, getQueueSize, getReceivedMessagesCnt, getState, here, isAlive, isRestarting, join, notifyChangeBehaviourState, notifyRestarted, postMessage, putBack, putO2AObject, receive, receive, registerO2AInterface, removeBehaviour, removeTimer, restartLater, restore, restoreBufferedState, run, send, setArguments, setEnabledO2ACommunication, setGenerateBehaviourEvents, setO2AManager, setQueueSize, waitUntilStarted, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface agentgui.simulationService.sensoring.ServiceSensorInterface

doDelete, getAID, setMigration, setPauseSimulation

Field Detail

mySensor

protected ServiceSensor mySensor

The ServiceSensor of this agent.

myEnvironmentModel

protected EnvironmentModel myEnvironmentModel

The current EnvironmentModel.

Constructor Detail

SimulationAgent

public SimulationAgent()

Instantiates a new simulation agent as an active agent.

SimulationAgent

public SimulationAgent(boolean passive)

Instantiates a new simulation agent as a passive agent. The agent will just listening to changes in the environment model but it is not expected, that it will react on it. This is used for example for agents, which are displaying the current environment.

Parameters:

passive - the passive

Method Detail

setup

protected void setup()

Overrides:

setup in class jade.core.Agent

beforeMove

protected void beforeMove()

Overrides:

beforeMove in class jade.core.Agent

afterMove

protected void afterMove()

Overrides:

afterMove in class jade.core.Agent

beforeClone

protected void beforeClone()

Overrides:

beforeClone in class jade.core.Agent

afterClone

protected void afterClone()

Overrides:

afterClone in class jade.core.Agent

takeDown

protected void takeDown()

Overrides:

takeDown in class jade.core.Agent

sensorPlugIn

protected void sensorPlugIn()

This Method plugs IN the service sensor.

sensorPlugOut

protected void sensorPlugOut()

This Method plugs OUT the service sensor.

getEnvironmentModelFromSimulationService

protected EnvironmentModel getEnvironmentModelFromSimulationService()

Grab the environment model from the simulation service.

Returns:

the current EnvironmentModel

checkAndActOnEnvironmentChanges

protected void checkAndActOnEnvironmentChanges()

This Method checks if the environment changed in the meantime. If so, the method 'onEnvironmentStimulus' will be fired

setEnvironmentModel

public void setEnvironmentModel(EnvironmentModel envModel,
                                boolean aSynchron)

Description copied from interface: ServiceSensorInterface

This method will be used by the ServiceActuator to inform this agent about changes in the environment. It can be either used to do this asynchronously or synchronously. It is highly recommended to do this asynchronously, so that the agency can act parallel and not sequentially.

Specified by:

setEnvironmentModel in interface ServiceSensorInterface

Parameters:

envModel - the current or new EnvironmentModel

aSynchron - true, if this should be done asynchronously

onEnvironmentStimulus

public abstract void onEnvironmentStimulus()

This method is called if a stimulus from the outside reached this agent. It can be overwritten in the child class to act on environment changes.

setMyStimulusAnswer

protected void setMyStimulusAnswer(java.lang.Object myNextState)

This method sets the answer respectively the change of a single simulation agent back to the central simulation manager.

Parameters:

myNextState - the next state of this agent in the next instance of the environment model

sendManagerNotification

public boolean sendManagerNotification(java.lang.Object notification)

This method can be used to transfer any kind of information to the Manager of the current environment model.

Parameters:

notification - the notification

Returns:

true, if successful

sendAgentNotification

public boolean sendAgentNotification(jade.core.AID receiverAID,
                                     java.lang.Object notification)

This method can be used to transfer any kind of information to one member of the current environment model.

Parameters:

receiverAID - the AID of receiver agent

notification - the notification

Returns:

true, if successful

sendDisplayAgentNotification

public void sendDisplayAgentNotification(DisplayAgentNotification displayAgentNotification)

Notify display agents about changes with a DisplayAgentNotification.

Parameters:

displayAgentNotification - the display agent message

setNotification

public void setNotification(EnvironmentNotification notification)

Description copied from interface: ServiceSensorInterface

This method can be invoked from the simulation service, if a notification for the manager has to be delivered.

Specified by:

setNotification in interface ServiceSensorInterface

Parameters:

notification - the new notification

onEnvironmentNotification

protected EnvironmentNotification onEnvironmentNotification(EnvironmentNotification notification)

This method will be executed if a ManagerNotification arrives this agent.

Parameters:

notification - the notification

addSimulationServiceListener

public void addSimulationServiceListener(ServiceSensorListener simulationServiceListener)

Adds the simulation service listener.

Parameters:

simulationServiceListener - the simulation service listener

removeSimulationServiceListener

public void removeSimulationServiceListener(ServiceSensorListener simulationServiceListener)

Removes the simulation service listener.

Parameters:

simulationServiceListener - the simulation service listener

registerDFService

protected void registerDFService(java.lang.String type,
                                 java.lang.String name,
                                 java.lang.String ownership)

Registers a service for the agency to the DFService of JADE.

Parameters:

type - the type

name - the name

deregisterDFService

protected void deregisterDFService()

Unregisters a service for the agency to the DFService of JADE.

findAgentsByServiceType

protected jade.domain.FIPAAgentManagement.DFAgentDescription[] findAgentsByServiceType(java.lang.String serviceType)

Find and returns agents by a service type.

Parameters:

serviceType - the service type

Returns:

the dF agent description[]