agentgui.simulationService.sensoring

Class ServiceActuator

java.lang.Object

java.lang.Thread

agentgui.simulationService.sensoring.ServiceActuator

All Implemented Interfaces:

java.lang.Runnable

public class ServiceActuator
extends java.lang.Thread

This is the class for an actuator of the SimulationService, which is able to inform all connected SimulationAgent with an integrated ServiceSensor about a new EnvironmentModel or with an EnvironmentNotification. Furthermore it can inform the connected agents about the Location, where they have to migrate, delegated by the load balancing process, or that they just have to die.

The functionalities are not finalised yet.

See Also:

SimulationService, SimulationAgent, ServiceSensor, EnvironmentModel, EnvironmentNotification, Location

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ServiceActuator(java.lang.String containerName) Instantiates a new service actuator.

Method Summary

Modifier and Type	Method and Description
int	getNoOfSimulationAnswersExpected() Returns the number of simulation answers expected.
jade.core.AID[]	getSensorAgents() Returns all agents registered to this actuator by a sensor.
void	notifySensor(EnvironmentModel environmentModel, jade.core.AID aid) Notifies the sensor of the specified agent about a new environment model.
boolean	notifySensorAgent(jade.core.AID aid, EnvironmentNotification notification) Notifies an agent through the service sensor.
void	notifySensorAgentsDoDelete() This method will kill all registered SimulationAgents to provide a faster(!)
void	notifySensorPauseSimulation(boolean isPauseSimulation) Notify that simulation has to be paused or not.
void	notifySensors(EnvironmentModel environmentModel, boolean async) This method informs all Sensors about the new environment model.
void	plugIn(ServiceSensor currSensor) Method for agents to plug-in to this actuator.
void	plugInPassive(ServiceSensor currSensor) Method for agents to plug-in to this actuator, but it is not expected that the connected agent will answer to the change of the environment.
void	plugOut(ServiceSensor currSensor) Method to plug-out from this actuator
void	run()
void	setMigration(java.util.Vector<LoadAgentMap.AID_Container> transferAgents) This method will place a 'newLocation'-Object to every agent which is registered to this actuator.
void	shutdown() Manages to shutdown the Thread of this ServiceActuator.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceActuator

public ServiceActuator(java.lang.String containerName)

Instantiates a new service actuator.

Parameters:

containerName - the container name

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

shutdown

public void shutdown()

Manages to shutdown the Thread of this ServiceActuator.

plugIn

public void plugIn(ServiceSensor currSensor)

Method for agents to plug-in to this actuator.

Parameters:

currSensor - the ServiceSensor to plug-in

plugInPassive

public void plugInPassive(ServiceSensor currSensor)

Method for agents to plug-in to this actuator, but it is not expected that the connected agent will answer to the change of the environment.

Parameters:

currSensor - the ServiceSensor to plug-in

plugOut

public void plugOut(ServiceSensor currSensor)

Method to plug-out from this actuator

Parameters:

currSensor - the ServiceSensor to plug-out

getSensorAgents

public jade.core.AID[] getSensorAgents()

Returns all agents registered to this actuator by a sensor.

Returns:

the sensor agents

getNoOfSimulationAnswersExpected

public int getNoOfSimulationAnswersExpected()

Returns the number of simulation answers expected.

Returns:

the noOfSimulationAnswersExpected

notifySensors

public void notifySensors(EnvironmentModel environmentModel,
                          boolean async)

This method informs all Sensors about the new environment model. It can be either used to do this asynchronously or asynchronously, but it. is highly recommended to do this asynchronously, so that the agency can act parallel and not sequential.

Parameters:

environmentModel - the new EnvironmentModel

async - set true, if this should be done asynchronously

notifySensor

public void notifySensor(EnvironmentModel environmentModel,
                         jade.core.AID aid)

Notifies the sensor of the specified agent about a new environment model.

Parameters:

environmentModel - the environment model

aid - the aid of the designated agent

notifySensorAgentsDoDelete

public void notifySensorAgentsDoDelete()

This method will kill all registered SimulationAgents to provide a faster(!) shutdown of the system.

notifySensorPauseSimulation

public void notifySensorPauseSimulation(boolean isPauseSimulation)

Notify that simulation has to be paused or not.

Parameters:

isPauseSimulation - the is pause simulation

setMigration

public void setMigration(java.util.Vector<LoadAgentMap.AID_Container> transferAgents)

This method will place a 'newLocation'-Object to every agent which is registered to this actuator.

Parameters:

transferAgents - the Vector of agents to migrate

notifySensorAgent

public boolean notifySensorAgent(jade.core.AID aid,
                                 EnvironmentNotification notification)

Notifies an agent through the service sensor.

Parameters:

aid - the aid

notification - the notification

Returns:

true, if successful