agentgui.simulationService

Class SimulationServiceProxy

java.lang.Object

jade.core.SliceProxy

agentgui.simulationService.SimulationServiceProxy

All Implemented Interfaces:

SimulationServiceSlice, jade.core.Service.Slice, java.io.Serializable

public class SimulationServiceProxy
extends jade.core.SliceProxy
implements SimulationServiceSlice

This class provides the reals functionalities for the SimulationServiceSlice.

See Also:

Serialized Form

Field Summary

Fields inherited from interface agentgui.simulationService.SimulationServiceSlice

SERVICE_DISPLAY_AGENT_NOTIFICATION, SERVICE_DISPLAY_AGENT_SET_ENVIRONMENT_MODEL, SERVICE_DISPLAY_CONTAINER_UN_REGISTRATION, SERVICE_SET_AGENT_MIGRATION, SERVICE_STOP_SIMULATION_AGENTS, SERVICE_SYNCH_GET_REMOTE_TIME, SERVICE_SYNCH_SET_TIME_DIFF, SIM_GET_ENVIRONMENT_MODEL_FROM_SETUP, SIM_GET_ENVIRONMENT_NEXT_PARTS, SIM_NOTIFY_AGENT, SIM_NOTIFY_MANAGER, SIM_NOTIFY_MANAGER_PUT_AGENT_ANSWERS, SIM_PAUSE_SIMULATION, SIM_RESET_ENVIRONMENT_NEXT_PARTS, SIM_SET_ANSWERS_EXPECTED, SIM_SET_ENVIRONMENT_MODEL, SIM_SET_ENVIRONMENT_NEXT_PART, SIM_SET_MANAGER_AGENT, SIM_STEP_SIMULATION

Constructor Summary

Constructors

Constructor and Description
SimulationServiceProxy()

Method Summary

Modifier and Type	Method and Description
void	displayAgentNotification(EnvironmentNotification notification) Notifies all registered DisplayAgents.
void	displayAgentSetEnvironmentModel(EnvironmentModel envModel) Notifies all registered DisplayAgents about a new EnvironmentModel.
void	doDisplayAgentContainerUnRegister(java.lang.String containerName, boolean isRegisterContainer) Does the (un-)registration for a display agent in a container .
java.util.Hashtable<jade.core.AID,java.lang.Object>	getEnvironmentInstanceNextParts() This method returns the complete environment-model-changes from the Main-Container.
EnvironmentModel	getEnvironmentModelFromSetup() Returns the EnvironmentModel from the setup within the end user application.
long	getRemoteTime() Returns the remote time as long.
boolean	notifyAgent(jade.core.AID agentAID, EnvironmentNotification notification) Notifies a specified sensor agent by using an EnvironmentNotification.
boolean	notifyManager(EnvironmentNotification notification) Notifies a SimulationManager by using an EnvironmentNotification.
void	notifyManagerPutAgentAnswers(java.util.Hashtable<jade.core.AID,java.lang.Object> allAgentAnswers) Sends the current set of agent answers to the manager agent of the environment.
void	resetEnvironmentInstanceNextParts() This method resets the hash with the single environment-model-changes.
void	setAgentMigration(java.util.Vector<LoadAgentMap.AID_Container> transferAgents) Sets the new locations to the agents.
void	setAnswersExpected(int answersExpected) Sets the number of changes/answers expected from the simulation cycle.
void	setEnvironmentInstanceNextPart(java.util.Hashtable<jade.core.AID,java.lang.Object> nextPartsLocal) Sends the local next parts of the environment-model to the Main-Container.
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(EnvironmentManagerDescription envManager) Sets the EnvironmentManagerDescription of the manager agent.
void	setPauseSimulation(boolean pauseSimulation) Sets to pause the simulation.
void	setRemoteTimeDiff(long timeDifference) Sets the remote time difference in milliseconds for synchronised time.
void	stepSimulation(EnvironmentModel envModel, boolean aSynchron) Steps a simulation by using the current EnvironmentModel and the number of expected changes / answers.
void	stopSimulationAgents() Stops the simulation agents.

Methods inherited from class jade.core.SliceProxy

getNode, getService, serve, setNode

Methods inherited from class java.lang.Object

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

Methods inherited from interface jade.core.Service.Slice

getNode, getService, serve

Constructor Detail

SimulationServiceProxy

public SimulationServiceProxy()

Method Detail

getRemoteTime

public long getRemoteTime()
                   throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Returns the remote time as long.

Specified by:

getRemoteTime in interface SimulationServiceSlice

Returns:

the remote time

Throws:

jade.core.IMTPException - the IMTPException

setRemoteTimeDiff

public void setRemoteTimeDiff(long timeDifference)
                       throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Sets the remote time difference in milliseconds for synchronised time.

Specified by:

setRemoteTimeDiff in interface SimulationServiceSlice

Parameters:

timeDifference - the new remote time diff

Throws:

jade.core.IMTPException - the IMTPException

setManagerAgent

public void setManagerAgent(EnvironmentManagerDescription envManager)
                     throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Sets the EnvironmentManagerDescription of the manager agent.

Specified by:

setManagerAgent in interface SimulationServiceSlice

Parameters:

envManager - the new manager agent

Throws:

jade.core.IMTPException - the IMTPException

See Also:

EnvironmentManagerDescription

getEnvironmentModelFromSetup

public EnvironmentModel getEnvironmentModelFromSetup()
                                              throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

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

Specified by:

getEnvironmentModelFromSetup in interface SimulationServiceSlice

Returns:

the environment model from the setup

Throws:

jade.core.IMTPException - the IMTP exception

setEnvironmentModel

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

Description copied from interface: SimulationServiceSlice

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

Specified by:

setEnvironmentModel in interface SimulationServiceSlice

Parameters:

envModel - the current or new EnvironmentModel instance

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

Throws:

jade.core.IMTPException - the IMTPException

See Also:

EnvironmentModel

stepSimulation

public void stepSimulation(EnvironmentModel envModel,
                           boolean aSynchron)
                    throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

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

Specified by:

stepSimulation in interface SimulationServiceSlice

Parameters:

envModel - the current or new EnvironmentModel

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

Throws:

jade.core.IMTPException - the iMTP exception

See Also:

EnvironmentModel

setAnswersExpected

public void setAnswersExpected(int answersExpected)
                        throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Sets the number of changes/answers expected from the simulation cycle.

Specified by:

setAnswersExpected in interface SimulationServiceSlice

Parameters:

answersExpected - the number of answers expected

Throws:

jade.core.IMTPException - the IMTPException

notifyAgent

public boolean notifyAgent(jade.core.AID agentAID,
                           EnvironmentNotification notification)
                    throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Notifies a specified sensor agent by using an EnvironmentNotification.

Specified by:

notifyAgent in interface SimulationServiceSlice

Parameters:

agentAID - the agent AID

notification - the notification

Returns:

true, if successful

Throws:

jade.core.IMTPException - the IMTPException

See Also:

ServiceSensor, ServiceActuator, SimulationAgent, EnvironmentNotification

setPauseSimulation

public void setPauseSimulation(boolean pauseSimulation)
                        throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Sets to pause the simulation.

Specified by:

setPauseSimulation in interface SimulationServiceSlice

Parameters:

pauseSimulation - the new pause simulation

Throws:

jade.core.IMTPException - the IMTPException

setEnvironmentInstanceNextPart

public void setEnvironmentInstanceNextPart(java.util.Hashtable<jade.core.AID,java.lang.Object> nextPartsLocal)
                                    throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Sends the local next parts of the environment-model to the Main-Container.

Specified by:

setEnvironmentInstanceNextPart in interface SimulationServiceSlice

Parameters:

nextPartsLocal - the Hashtable of local environment changes, coming from different agents

Throws:

jade.core.IMTPException - the IMTPException

notifyManager

public boolean notifyManager(EnvironmentNotification notification)
                      throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Notifies a SimulationManager by using an EnvironmentNotification.

Specified by:

notifyManager in interface SimulationServiceSlice

Parameters:

notification - the notification

Returns:

true, if successful

Throws:

jade.core.IMTPException - the IMTPException

See Also:

SimulationManagerAgent, EnvironmentNotification

notifyManagerPutAgentAnswers

public void notifyManagerPutAgentAnswers(java.util.Hashtable<jade.core.AID,java.lang.Object> allAgentAnswers)
                                  throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Sends the current set of agent answers to the manager agent of the environment.

Specified by:

notifyManagerPutAgentAnswers in interface SimulationServiceSlice

Parameters:

allAgentAnswers - the Hashtable of all agent answers

Throws:

jade.core.IMTPException - the IMTPException

getEnvironmentInstanceNextParts

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

Description copied from interface: SimulationServiceSlice

This method returns the complete environment-model-changes from the Main-Container.

Specified by:

getEnvironmentInstanceNextParts in interface SimulationServiceSlice

Returns:

the environment instance next parts

Throws:

jade.core.IMTPException - the IMTPException

resetEnvironmentInstanceNextParts

public void resetEnvironmentInstanceNextParts()
                                       throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

This method resets the hash with the single environment-model-changes.

Specified by:

resetEnvironmentInstanceNextParts in interface SimulationServiceSlice

Throws:

jade.core.IMTPException - the IMTPException

stopSimulationAgents

public void stopSimulationAgents()
                          throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Stops the simulation agents.

Specified by:

stopSimulationAgents in interface SimulationServiceSlice

Throws:

jade.core.IMTPException - the IMTPException

setAgentMigration

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

Description copied from interface: SimulationServiceSlice

Sets the new locations to the agents.

Specified by:

setAgentMigration in interface SimulationServiceSlice

Parameters:

transferAgents - the agents to migrate

Throws:

jade.core.IMTPException - the IMTPException

See Also:

LoadAgentMap.AID_Container

displayAgentSetEnvironmentModel

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

Description copied from interface: SimulationServiceSlice

Notifies all registered DisplayAgents about a new EnvironmentModel.

Specified by:

displayAgentSetEnvironmentModel in interface SimulationServiceSlice

Parameters:

envModel - the EnvironmentModel

Throws:

jade.core.IMTPException - the iMTP exception

displayAgentNotification

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

Description copied from interface: SimulationServiceSlice

Notifies all registered DisplayAgents.

Specified by:

displayAgentNotification in interface SimulationServiceSlice

Parameters:

notification - the notification

Throws:

jade.core.IMTPException - the iMTP exception

doDisplayAgentContainerUnRegister

public void doDisplayAgentContainerUnRegister(java.lang.String containerName,
                                              boolean isRegisterContainer)
                                       throws jade.core.IMTPException

Description copied from interface: SimulationServiceSlice

Does the (un-)registration for a display agent in a container .

Specified by:

doDisplayAgentContainerUnRegister in interface SimulationServiceSlice

Parameters:

containerName - the container name

isRegisterContainer - the is register container

Throws:

jade.core.IMTPException - the IMTP exception