agentgui.simulationService

Interface SimulationServiceSlice

All Superinterfaces:

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

All Known Implementing Classes:

SimulationServiceProxy

public interface SimulationServiceSlice
extends jade.core.Service.Slice

Here the remotely accessible methods of the SimulationService can be found.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVICE_DISPLAY_AGENT_NOTIFICATION
static java.lang.String	SERVICE_DISPLAY_AGENT_SET_ENVIRONMENT_MODEL The Constant SERVICE_DISPLAY_AGENT_NOTIFY.
static java.lang.String	SERVICE_DISPLAY_CONTAINER_UN_REGISTRATION
static java.lang.String	SERVICE_SET_AGENT_MIGRATION The Constant SERVICE_SET_AGENT_MIGRATION.
static java.lang.String	SERVICE_STOP_SIMULATION_AGENTS The Constant SERVICE_STOP_SIMULATION_AGENTS.
static java.lang.String	SERVICE_SYNCH_GET_REMOTE_TIME The Constant SERVICE_SYNCH_GET_REMOTE_TIME.
static java.lang.String	SERVICE_SYNCH_SET_TIME_DIFF The Constant SERVICE_SYNCH_SET_TIME_DIFF.
static java.lang.String	SIM_GET_ENVIRONMENT_MODEL_FROM_SETUP The Constant SIM_SET_ENVIRONMENT_MODEL_FROM_SETUP.
static java.lang.String	SIM_GET_ENVIRONMENT_NEXT_PARTS The Constant SIM_GET_ENVIRONMENT_NEXT_PARTS.
static java.lang.String	SIM_NOTIFY_AGENT The Constant SIM_NOTIFY_AGENT.
static java.lang.String	SIM_NOTIFY_MANAGER The Constant SIM_NOTIFY_MANAGER.
static java.lang.String	SIM_NOTIFY_MANAGER_PUT_AGENT_ANSWERS The Constant SIM_NOTIFY_MANAGER_PUT_AGENT_ANSWERS.
static java.lang.String	SIM_PAUSE_SIMULATION The Constant SIM_PAUSE_SIMULATION.
static java.lang.String	SIM_RESET_ENVIRONMENT_NEXT_PARTS The Constant SIM_RESET_ENVIRONMENT_NEXT_PARTS.
static java.lang.String	SIM_SET_ANSWERS_EXPECTED The Constant SIM_SET_ANSWERS_EXPECTED.
static java.lang.String	SIM_SET_ENVIRONMENT_MODEL The Constant SIM_SET_ENVIRONMENT_MODEL.
static java.lang.String	SIM_SET_ENVIRONMENT_NEXT_PART The Constant SIM_SET_ENVIRONMENT_NEXT_PART.
static java.lang.String	SIM_SET_MANAGER_AGENT The Constant SIM_SET_MANAGER_AGENT.
static java.lang.String	SIM_STEP_SIMULATION The Constant SIM_STEP_SIMULATION.

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 interface jade.core.Service.Slice

getNode, getService, serve

Field Detail

SERVICE_SYNCH_GET_REMOTE_TIME

static final java.lang.String SERVICE_SYNCH_GET_REMOTE_TIME

The Constant SERVICE_SYNCH_GET_REMOTE_TIME.

See Also:

Constant Field Values

SERVICE_SYNCH_SET_TIME_DIFF

static final java.lang.String SERVICE_SYNCH_SET_TIME_DIFF

The Constant SERVICE_SYNCH_SET_TIME_DIFF.

See Also:

Constant Field Values

SIM_SET_MANAGER_AGENT

static final java.lang.String SIM_SET_MANAGER_AGENT

The Constant SIM_SET_MANAGER_AGENT.

See Also:

Constant Field Values

SIM_GET_ENVIRONMENT_MODEL_FROM_SETUP

static final java.lang.String SIM_GET_ENVIRONMENT_MODEL_FROM_SETUP

The Constant SIM_SET_ENVIRONMENT_MODEL_FROM_SETUP.

See Also:

Constant Field Values

SIM_SET_ENVIRONMENT_MODEL

static final java.lang.String SIM_SET_ENVIRONMENT_MODEL

The Constant SIM_SET_ENVIRONMENT_MODEL.

See Also:

Constant Field Values

SIM_STEP_SIMULATION

static final java.lang.String SIM_STEP_SIMULATION

The Constant SIM_STEP_SIMULATION.

See Also:

Constant Field Values

SIM_SET_ANSWERS_EXPECTED

static final java.lang.String SIM_SET_ANSWERS_EXPECTED

The Constant SIM_SET_ANSWERS_EXPECTED.

See Also:

Constant Field Values

SIM_NOTIFY_AGENT

static final java.lang.String SIM_NOTIFY_AGENT

The Constant SIM_NOTIFY_AGENT.

See Also:

Constant Field Values

SIM_NOTIFY_MANAGER

static final java.lang.String SIM_NOTIFY_MANAGER

The Constant SIM_NOTIFY_MANAGER.

See Also:

Constant Field Values

SIM_NOTIFY_MANAGER_PUT_AGENT_ANSWERS

static final java.lang.String SIM_NOTIFY_MANAGER_PUT_AGENT_ANSWERS

The Constant SIM_NOTIFY_MANAGER_PUT_AGENT_ANSWERS.

See Also:

Constant Field Values

SIM_SET_ENVIRONMENT_NEXT_PART

static final java.lang.String SIM_SET_ENVIRONMENT_NEXT_PART

The Constant SIM_SET_ENVIRONMENT_NEXT_PART.

See Also:

Constant Field Values

SIM_GET_ENVIRONMENT_NEXT_PARTS

static final java.lang.String SIM_GET_ENVIRONMENT_NEXT_PARTS

The Constant SIM_GET_ENVIRONMENT_NEXT_PARTS.

See Also:

Constant Field Values

SIM_RESET_ENVIRONMENT_NEXT_PARTS

static final java.lang.String SIM_RESET_ENVIRONMENT_NEXT_PARTS

The Constant SIM_RESET_ENVIRONMENT_NEXT_PARTS.

See Also:

Constant Field Values

SERVICE_STOP_SIMULATION_AGENTS

static final java.lang.String SERVICE_STOP_SIMULATION_AGENTS

The Constant SERVICE_STOP_SIMULATION_AGENTS.

See Also:

Constant Field Values

SIM_PAUSE_SIMULATION

static final java.lang.String SIM_PAUSE_SIMULATION

The Constant SIM_PAUSE_SIMULATION.

See Also:

Constant Field Values

SERVICE_SET_AGENT_MIGRATION

static final java.lang.String SERVICE_SET_AGENT_MIGRATION

The Constant SERVICE_SET_AGENT_MIGRATION.

See Also:

Constant Field Values

SERVICE_DISPLAY_AGENT_SET_ENVIRONMENT_MODEL

static final java.lang.String SERVICE_DISPLAY_AGENT_SET_ENVIRONMENT_MODEL

The Constant SERVICE_DISPLAY_AGENT_NOTIFY.

See Also:

Constant Field Values

SERVICE_DISPLAY_AGENT_NOTIFICATION

static final java.lang.String SERVICE_DISPLAY_AGENT_NOTIFICATION

See Also:

Constant Field Values

SERVICE_DISPLAY_CONTAINER_UN_REGISTRATION

static final java.lang.String SERVICE_DISPLAY_CONTAINER_UN_REGISTRATION

See Also:

Constant Field Values

Method Detail

getRemoteTime

long getRemoteTime()
            throws jade.core.IMTPException

Returns the remote time as long.

Returns:

the remote time

Throws:

jade.core.IMTPException - the IMTPException

setRemoteTimeDiff

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

Sets the remote time difference in milliseconds for synchronised time.

Parameters:

timeDifference - the new remote time diff

Throws:

jade.core.IMTPException - the IMTPException

setManagerAgent

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

Sets the EnvironmentManagerDescription of the manager agent.

Parameters:

envManager - the new manager agent

Throws:

jade.core.IMTPException - the IMTPException

See Also:

EnvironmentManagerDescription

getEnvironmentModelFromSetup

EnvironmentModel getEnvironmentModelFromSetup()
                                       throws jade.core.IMTPException

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

Returns:

the environment model from the setup

Throws:

jade.core.IMTPException - the IMTP exception

setEnvironmentModel

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

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

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

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

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

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

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

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

Parameters:

answersExpected - the number of answers expected

Throws:

jade.core.IMTPException - the IMTPException

notifyAgent

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

Notifies a specified sensor agent by using an EnvironmentNotification.

Parameters:

agentAID - the agent AID

notification - the notification

Returns:

true, if successful

Throws:

jade.core.IMTPException - the IMTPException

See Also:

ServiceSensor, ServiceActuator, SimulationAgent, EnvironmentNotification

notifyManager

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

Notifies a SimulationManager by using an EnvironmentNotification.

Parameters:

notification - the notification

Returns:

true, if successful

Throws:

jade.core.IMTPException - the IMTPException

See Also:

SimulationManagerAgent, EnvironmentNotification

notifyManagerPutAgentAnswers

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

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

Parameters:

allAgentAnswers - the Hashtable of all agent answers

Throws:

jade.core.IMTPException - the IMTPException

setEnvironmentInstanceNextPart

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

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

Parameters:

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

Throws:

jade.core.IMTPException - the IMTPException

getEnvironmentInstanceNextParts

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

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

Returns:

the environment instance next parts

Throws:

jade.core.IMTPException - the IMTPException

resetEnvironmentInstanceNextParts

void resetEnvironmentInstanceNextParts()
                                throws jade.core.IMTPException

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

Throws:

jade.core.IMTPException - the IMTPException

stopSimulationAgents

void stopSimulationAgents()
                   throws jade.core.IMTPException

Stops the simulation agents.

Throws:

jade.core.IMTPException - the IMTPException

setPauseSimulation

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

Sets to pause the simulation.

Parameters:

pauseSimulation - the new pause simulation

Throws:

jade.core.IMTPException - the IMTPException

setAgentMigration

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

Sets the new locations to the agents.

Parameters:

transferAgents - the agents to migrate

Throws:

jade.core.IMTPException - the IMTPException

See Also:

LoadAgentMap.AID_Container

displayAgentSetEnvironmentModel

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

Notifies all registered DisplayAgents about a new EnvironmentModel.

Parameters:

envModel - the EnvironmentModel

Throws:

jade.core.IMTPException - the iMTP exception

displayAgentNotification

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

Notifies all registered DisplayAgents.

Parameters:

notification - the notification

Throws:

jade.core.IMTPException - the iMTP exception

doDisplayAgentContainerUnRegister

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

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

Parameters:

containerName - the container name

isRegisterContainer - the is register container

Throws:

jade.core.IMTPException - the IMTP exception