agentgui.simulationService

Class SimulationService.SimulationServiceImpl

java.lang.Object

agentgui.simulationService.SimulationService.SimulationServiceImpl

All Implemented Interfaces:

SimulationServiceHelper, jade.core.ServiceHelper

Enclosing class:

SimulationService

public class SimulationService.SimulationServiceImpl
extends java.lang.Object
implements SimulationServiceHelper

Sub-Class to provide interaction between Agents and this Service.

Field Summary

Fields inherited from interface agentgui.simulationService.SimulationServiceHelper

SERVICE_NAME, SERVICE_NODE_DESCRIPTION_FILE

Constructor Summary

Constructors

Constructor and Description
SimulationServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	displayAgentNotification(EnvironmentNotification notification) Notifies all registered DisplayAgents.
void	displayAgentRegister(AbstractDisplayAgent displayAgent) Registers a DisplayAgent at the SimulationService.
void	displayAgentSetEnvironmentModel(EnvironmentModel envModel) Notifies all registered DisplayAgents about a new EnvironmentModel.
void	displayAgentUnregister(AbstractDisplayAgent displayAgent) Unregisters a DisplayAgent at the SimulationService.
java.util.Hashtable<jade.core.AID,java.lang.Object>	getEnvironmentInstanceNextParts() Gets the parts for the next environment instance coming from different SimulationAgent.
EnvironmentModel	getEnvironmentModel() Returns the current the EnvironmentModel.
EnvironmentModel	getEnvironmentModelFromSetup() Returns the EnvironmentModel from the setup of the end user application.
jade.core.AID	getManagerAgent() Returns the manager agent for the simulation/environment.
boolean	getStepSimulationAsynchronous() Returns the information, if the notification about environment changes has to be done asynchronously.
java.util.Date	getSynchTimeDate() Returns the synchronised time as date.
long	getSynchTimeDifferenceMillis() Returns the difference in milliseconds for synchronised time.
long	getSynchTimeMillis() Returns the synchronised time in milliseconds.
void	init(jade.core.Agent ag)
boolean	notifyManagerAgent(EnvironmentNotification notification) Notifies a SimulationManager by using an EnvironmentNotification.
boolean	notifySensorAgent(jade.core.AID agentAID, EnvironmentNotification notification) Notifies a specified sensor agent by using an EnvironmentNotification.
void	resetEnvironmentInstanceNextParts() This method will reset the Hashtable of environment changes for the next environment instance.
void	sensorPlugIn(ServiceSensor sensor) Allows to plug in a ServiceSensor into the SimulationService.
void	sensorPlugIn(ServiceSensor sensor, boolean pasive) Allows to plug in a ServiceSensor into the SimulationService.
void	sensorPlugIn4Manager(ServiceSensorManager sensor) Allows to plug in a ServiceSensorManager into the SimulationService.
void	sensorPlugOut(ServiceSensor sensor) Allows to plug out a ServiceSensor into the SimulationService.
void	sensorPlugOut4Manager(ServiceSensorManager sensor) Allows to plug out a ServiceSensorManager into the SimulationService.
void	setAgentMigration(java.util.Vector<LoadAgentMap.AID_Container> transferAgents) Sets the agents to migrate to a different location/container.
void	setEnvironmentInstanceNextPart(jade.core.AID fromAgent, java.lang.Object nextPart) This method can be used by a SimulationAgent in order to set their part of the environment change.
void	setEnvironmentModel(EnvironmentModel envModel) Can be used in order to set and distribute an EnvironmentModel without a direct notification to the involved agents.
void	setEnvironmentModel(EnvironmentModel envModel, boolean notifySensorAgents) Can be used in order to set and distribute an EnvironmentModel without a direct notification to the involved agents.
void	setManagerAgent(jade.core.AID agentAddress) Sets the manager agent of the simulation/environment.
void	setPauseSimulation(boolean pause) Sets the pause of the simulation.
void	setStepSimulationAsynchronous(boolean stepAsynchronous) Sets to step a simulation by notify all involved agents in a asynchronous way.
void	stepSimulation(EnvironmentModel envModel, int answersExpected) Steps a simulation by using the current EnvironmentModel and the number of expected changes / answers.
void	stepSimulation(EnvironmentModel envModel, int answersExpected, boolean aSynchron) Steps a simulation by using the current EnvironmentModel and the number of expected changes / answers.
void	stopSimulationAgents() Stops all agents, which are connected to the SimulationService via the Actuator/Sensor relationship .

Methods inherited from class java.lang.Object

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

Constructor Detail

SimulationServiceImpl

public SimulationServiceImpl()

Method Detail

init

public void init(jade.core.Agent ag)

Specified by:

init in interface jade.core.ServiceHelper

getSynchTimeDifferenceMillis

public long getSynchTimeDifferenceMillis()
                                  throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Returns the difference in milliseconds for synchronised time.

Specified by:

getSynchTimeDifferenceMillis in interface SimulationServiceHelper

Returns:

the time difference milliseconds for synchronised time

Throws:

jade.core.ServiceException - the ServiceException

getSynchTimeMillis

public long getSynchTimeMillis()
                        throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Returns the synchronised time in milliseconds.

Specified by:

getSynchTimeMillis in interface SimulationServiceHelper

Returns:

the synchronised time in milliseconds

Throws:

jade.core.ServiceException - the ServiceException

getSynchTimeDate

public java.util.Date getSynchTimeDate()
                                throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Returns the synchronised time as date.

Specified by:

getSynchTimeDate in interface SimulationServiceHelper

Returns:

the synchronised time date

Throws:

jade.core.ServiceException - the ServiceException

setAgentMigration

public void setAgentMigration(java.util.Vector<LoadAgentMap.AID_Container> transferAgents)
                       throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Sets the agents to migrate to a different location/container.

Specified by:

setAgentMigration in interface SimulationServiceHelper

Parameters:

transferAgents - the new agent migration

Throws:

jade.core.ServiceException - the ServiceException

See Also:

LoadAgentMap.AID_Container

stopSimulationAgents

public void stopSimulationAgents()
                          throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Stops all agents, which are connected to the SimulationService via the Actuator/Sensor relationship .

Specified by:

stopSimulationAgents in interface SimulationServiceHelper

Throws:

jade.core.ServiceException - the ServiceException

setPauseSimulation

public void setPauseSimulation(boolean pause)
                        throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Sets the pause of the simulation.

Specified by:

setPauseSimulation in interface SimulationServiceHelper

Parameters:

pause - the new pause simulation

Throws:

jade.core.ServiceException - the ServiceException

setManagerAgent

public void setManagerAgent(jade.core.AID agentAddress)
                     throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Sets the manager agent of the simulation/environment.

Specified by:

setManagerAgent in interface SimulationServiceHelper

Parameters:

agentAddress - the new manager agent

Throws:

jade.core.ServiceException - the ServiceException

getManagerAgent

public jade.core.AID getManagerAgent()
                              throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Returns the manager agent for the simulation/environment.

Specified by:

getManagerAgent in interface SimulationServiceHelper

Returns:

the manager agent

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugIn

public void sensorPlugIn(ServiceSensor sensor)
                  throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Allows to plug in a ServiceSensor into the SimulationService.

Specified by:

sensorPlugIn in interface SimulationServiceHelper

Parameters:

sensor - the ServiceSensor to plug in

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugIn

public void sensorPlugIn(ServiceSensor sensor,
                         boolean pasive)
                  throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Allows to plug in a ServiceSensor into the SimulationService.

Specified by:

sensorPlugIn in interface SimulationServiceHelper

Parameters:

sensor - the ServiceSensor to plug in

pasive - true, if the sensor is just listening to the actuator, but that there is no answer to expect

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugOut

public void sensorPlugOut(ServiceSensor sensor)
                   throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Allows to plug out a ServiceSensor into the SimulationService.

Specified by:

sensorPlugOut in interface SimulationServiceHelper

Parameters:

sensor - the ServiceSensor to plug out

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugIn4Manager

public void sensorPlugIn4Manager(ServiceSensorManager sensor)
                          throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Allows to plug in a ServiceSensorManager into the SimulationService.

Specified by:

sensorPlugIn4Manager in interface SimulationServiceHelper

Parameters:

sensor - the ServiceSensorManager to plug in

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugOut4Manager

public void sensorPlugOut4Manager(ServiceSensorManager sensor)
                           throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Allows to plug out a ServiceSensorManager into the SimulationService.

Specified by:

sensorPlugOut4Manager in interface SimulationServiceHelper

Parameters:

sensor - the ServiceSensorManager to plug out

Throws:

jade.core.ServiceException - the ServiceException

getStepSimulationAsynchronous

public boolean getStepSimulationAsynchronous()
                                      throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Returns the information, if the notification about environment changes has to be done asynchronously.

Specified by:

getStepSimulationAsynchronous in interface SimulationServiceHelper

Returns:

true, if asynchronously notification is set

Throws:

jade.core.ServiceException - the ServiceException

setStepSimulationAsynchronous

public void setStepSimulationAsynchronous(boolean stepAsynchronous)
                                   throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Sets to step a simulation by notify all involved agents in a asynchronous way.

Specified by:

setStepSimulationAsynchronous in interface SimulationServiceHelper

Parameters:

stepAsynchronous - true, if the notification has to be done asynchronously

Throws:

jade.core.ServiceException - the ServiceException

stepSimulation

public void stepSimulation(EnvironmentModel envModel,
                           int answersExpected)
                    throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Steps a simulation by using the current EnvironmentModel and the number of expected changes / answers.

Specified by:

stepSimulation in interface SimulationServiceHelper

Parameters:

envModel - the current or new EnvironmentModel

answersExpected - the changes / answers expected from the simulation agents

Throws:

jade.core.ServiceException - the ServiceException

See Also:

EnvironmentModel

stepSimulation

public void stepSimulation(EnvironmentModel envModel,
                           int answersExpected,
                           boolean aSynchron)
                    throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Steps a simulation by using the current EnvironmentModel and the number of expected changes / answers.

Specified by:

stepSimulation in interface SimulationServiceHelper

Parameters:

envModel - the current or new EnvironmentModel

answersExpected - the changes / answers expected from the simulation agents

aSynchron - true, if the notification has to be done asynchronously

Throws:

jade.core.ServiceException - the ServiceException

See Also:

EnvironmentModel

notifySensorAgent

public boolean notifySensorAgent(jade.core.AID agentAID,
                                 EnvironmentNotification notification)
                          throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Notifies a specified sensor agent by using an EnvironmentNotification.

Specified by:

notifySensorAgent in interface SimulationServiceHelper

Parameters:

agentAID - the agent AID

notification - the notification

Returns:

true, if successful

Throws:

jade.core.ServiceException - the ServiceException

See Also:

ServiceSensor, ServiceActuator, SimulationAgent, EnvironmentNotification

notifyManagerAgent

public boolean notifyManagerAgent(EnvironmentNotification notification)
                           throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Notifies a SimulationManager by using an EnvironmentNotification.

Specified by:

notifyManagerAgent in interface SimulationServiceHelper

Parameters:

notification - the notification

Returns:

true, if successful

Throws:

jade.core.ServiceException - the ServiceException

See Also:

SimulationManagerAgent, EnvironmentNotification

getEnvironmentModelFromSetup

public EnvironmentModel getEnvironmentModelFromSetup()
                                              throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Returns the EnvironmentModel from the setup of the end user application.

Specified by:

getEnvironmentModelFromSetup in interface SimulationServiceHelper

Returns:

the environment model from setup

Throws:

jade.core.ServiceException - the service exception

getEnvironmentModel

public EnvironmentModel getEnvironmentModel()
                                     throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Returns the current the EnvironmentModel.

Specified by:

getEnvironmentModel in interface SimulationServiceHelper

Returns:

the environment model

Throws:

jade.core.ServiceException - the ServiceException

See Also:

EnvironmentModel

setEnvironmentModel

public void setEnvironmentModel(EnvironmentModel envModel)
                         throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Can be used in order to set and distribute an EnvironmentModel without a direct notification to the involved agents.

Specified by:

setEnvironmentModel in interface SimulationServiceHelper

Parameters:

envModel - the current or new EnvironmentModel instance

Throws:

jade.core.ServiceException - the ServiceException

See Also:

EnvironmentModel

setEnvironmentModel

public void setEnvironmentModel(EnvironmentModel envModel,
                                boolean notifySensorAgents)
                         throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Can be used in order to set and distribute an EnvironmentModel without a direct notification to the involved agents.

Specified by:

setEnvironmentModel in interface SimulationServiceHelper

Parameters:

envModel - the current or new EnvironmentModel instance

notifySensorAgents - true, if the sensor agents should be also notified

Throws:

jade.core.ServiceException - the ServiceException

See Also:

EnvironmentModel

setEnvironmentInstanceNextPart

public void setEnvironmentInstanceNextPart(jade.core.AID fromAgent,
                                           java.lang.Object nextPart)
                                    throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

This method can be used by a SimulationAgent in order to set their part of the environment change.

Specified by:

setEnvironmentInstanceNextPart in interface SimulationServiceHelper

Parameters:

fromAgent - the AID of the agent

nextPart - the agents part for the next environment

Throws:

jade.core.ServiceException - the ServiceException

See Also:

SimulationAgent

getEnvironmentInstanceNextParts

public java.util.Hashtable<jade.core.AID,java.lang.Object> getEnvironmentInstanceNextParts()
                                                                                    throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Gets the parts for the next environment instance coming from different SimulationAgent.

Specified by:

getEnvironmentInstanceNextParts in interface SimulationServiceHelper

Returns:

the environment instance next parts

Throws:

jade.core.ServiceException - the ServiceException

resetEnvironmentInstanceNextParts

public void resetEnvironmentInstanceNextParts()
                                       throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

This method will reset the Hashtable of environment changes for the next environment instance.

Specified by:

resetEnvironmentInstanceNextParts in interface SimulationServiceHelper

Throws:

jade.core.ServiceException - the ServiceException

displayAgentRegister

public void displayAgentRegister(AbstractDisplayAgent displayAgent)
                          throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Registers a DisplayAgent at the SimulationService.

Specified by:

displayAgentRegister in interface SimulationServiceHelper

Parameters:

displayAgent - the instance of the display agent

Throws:

jade.core.ServiceException - the service exception

See Also:

AbstractDisplayAgent, SimulationService

displayAgentUnregister

public void displayAgentUnregister(AbstractDisplayAgent displayAgent)
                            throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Unregisters a DisplayAgent at the SimulationService.

Specified by:

displayAgentUnregister in interface SimulationServiceHelper

Parameters:

displayAgent - the instance of the display agent

Throws:

jade.core.ServiceException - the service exception

See Also:

AbstractDisplayAgent, SimulationService

displayAgentSetEnvironmentModel

public void displayAgentSetEnvironmentModel(EnvironmentModel envModel)
                                     throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Notifies all registered DisplayAgents about a new EnvironmentModel.

Specified by:

displayAgentSetEnvironmentModel in interface SimulationServiceHelper

Parameters:

envModel - the EnvironmentModel

Throws:

jade.core.ServiceException - the service exception

See Also:

AbstractDisplayAgent

displayAgentNotification

public void displayAgentNotification(EnvironmentNotification notification)
                              throws jade.core.ServiceException

Description copied from interface: SimulationServiceHelper

Notifies all registered DisplayAgents.

Specified by:

displayAgentNotification in interface SimulationServiceHelper

Parameters:

notification - the EnvironmentNotification

Throws:

jade.core.ServiceException - the service exception