agentgui.simulationService

Interface SimulationServiceHelper

All Superinterfaces:

jade.core.ServiceHelper

All Known Implementing Classes:

SimulationService.SimulationServiceImpl

public interface SimulationServiceHelper
extends jade.core.ServiceHelper

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVICE_NAME The Constant SERVICE_NAME.
static java.lang.String	SERVICE_NODE_DESCRIPTION_FILE The Constant SERVICE_NODE_DESCRIPTION_FILE.

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.
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 passive) 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 pauseSimulation) 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 interface jade.core.ServiceHelper

init

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME

The Constant SERVICE_NAME.

See Also:

Constant Field Values

SERVICE_NODE_DESCRIPTION_FILE

static final java.lang.String SERVICE_NODE_DESCRIPTION_FILE

The Constant SERVICE_NODE_DESCRIPTION_FILE.

See Also:

Constant Field Values

Method Detail

getSynchTimeDifferenceMillis

long getSynchTimeDifferenceMillis()
                           throws jade.core.ServiceException

Returns the difference in milliseconds for synchronised time.

Returns:

the time difference milliseconds for synchronised time

Throws:

jade.core.ServiceException - the ServiceException

getSynchTimeMillis

long getSynchTimeMillis()
                 throws jade.core.ServiceException

Returns the synchronised time in milliseconds.

Returns:

the synchronised time in milliseconds

Throws:

jade.core.ServiceException - the ServiceException

getSynchTimeDate

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

Returns the synchronised time as date.

Returns:

the synchronised time date

Throws:

jade.core.ServiceException - the ServiceException

stopSimulationAgents

void stopSimulationAgents()
                   throws jade.core.ServiceException

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

Throws:

jade.core.ServiceException - the ServiceException

setPauseSimulation

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

Sets the pause of the simulation.

Parameters:

pauseSimulation - the new pause simulation

Throws:

jade.core.ServiceException - the ServiceException

setAgentMigration

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

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

Parameters:

transferAgents - the new agent migration

Throws:

jade.core.ServiceException - the ServiceException

See Also:

LoadAgentMap.AID_Container

setManagerAgent

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

Sets the manager agent of the simulation/environment.

Parameters:

agentAddress - the new manager agent

Throws:

jade.core.ServiceException - the ServiceException

getManagerAgent

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

Returns the manager agent for the simulation/environment.

Returns:

the manager agent

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugIn

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

Allows to plug in a ServiceSensor into the SimulationService.

Parameters:

sensor - the ServiceSensor to plug in

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugIn

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

Allows to plug in a ServiceSensor into the SimulationService.

Parameters:

sensor - the ServiceSensor to plug in

passive - 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

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

Allows to plug out a ServiceSensor into the SimulationService.

Parameters:

sensor - the ServiceSensor to plug out

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugIn4Manager

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

Allows to plug in a ServiceSensorManager into the SimulationService.

Parameters:

sensor - the ServiceSensorManager to plug in

Throws:

jade.core.ServiceException - the ServiceException

sensorPlugOut4Manager

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

Allows to plug out a ServiceSensorManager into the SimulationService.

Parameters:

sensor - the ServiceSensorManager to plug out

Throws:

jade.core.ServiceException - the ServiceException

setStepSimulationAsynchronous

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

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

Parameters:

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

Throws:

jade.core.ServiceException - the ServiceException

getStepSimulationAsynchronous

boolean getStepSimulationAsynchronous()
                               throws jade.core.ServiceException

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

Returns:

true, if asynchronously notification is set

Throws:

jade.core.ServiceException - the ServiceException

stepSimulation

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

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

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

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

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

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

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

Notifies a specified sensor agent by using an EnvironmentNotification.

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

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

Notifies a SimulationManager by using an EnvironmentNotification.

Parameters:

notification - the notification

Returns:

true, if successful

Throws:

jade.core.ServiceException - the ServiceException

See Also:

SimulationManagerAgent, EnvironmentNotification

getEnvironmentModelFromSetup

EnvironmentModel getEnvironmentModelFromSetup()
                                       throws jade.core.ServiceException

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

Returns:

the environment model from setup

Throws:

jade.core.ServiceException - the service exception

getEnvironmentModel

EnvironmentModel getEnvironmentModel()
                              throws jade.core.ServiceException

Returns the current the EnvironmentModel.

Returns:

the environment model

Throws:

jade.core.ServiceException - the ServiceException

See Also:

EnvironmentModel

setEnvironmentModel

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

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

Throws:

jade.core.ServiceException - the ServiceException

See Also:

EnvironmentModel

setEnvironmentModel

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

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.ServiceException - the ServiceException

See Also:

EnvironmentModel

setEnvironmentInstanceNextPart

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

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

Parameters:

fromAgent - the AID of the agent

nextPart - the agents part for the next environment

Throws:

jade.core.ServiceException - the ServiceException

See Also:

SimulationAgent

resetEnvironmentInstanceNextParts

void resetEnvironmentInstanceNextParts()
                                throws jade.core.ServiceException

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

Throws:

jade.core.ServiceException - the ServiceException

getEnvironmentInstanceNextParts

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

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

Returns:

the environment instance next parts

Throws:

jade.core.ServiceException - the ServiceException

displayAgentRegister

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

Registers a DisplayAgent at the SimulationService.

Parameters:

displayAgent - the instance of the display agent

Throws:

jade.core.ServiceException - the service exception

See Also:

AbstractDisplayAgent, SimulationService

displayAgentUnregister

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

Unregisters a DisplayAgent at the SimulationService.

Parameters:

displayAgent - the instance of the display agent

Throws:

jade.core.ServiceException - the service exception

See Also:

AbstractDisplayAgent, SimulationService

displayAgentSetEnvironmentModel

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

Notifies all registered DisplayAgents about a new EnvironmentModel.

Parameters:

envModel - the EnvironmentModel

Throws:

jade.core.ServiceException - the service exception

See Also:

AbstractDisplayAgent

displayAgentNotification

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

Notifies all registered DisplayAgents.

Parameters:

notification - the EnvironmentNotification

Throws:

jade.core.ServiceException - the service exception