edu.utdallas.mavs.divas.core.client

Interface SimFacade

All Known Implementing Classes:

SimCommander

public interface SimFacade

This interface describes a facade for clients to interact with the simulation.

Method Summary

Modifier and Type	Method and Description
void	addSubscription(java.lang.String topic, Subscriber subscriber) Adds a client subscription to the message broker
void	createAgent(AgentState agent) Creates an agent in the simulation.
void	createEnvObject(EnvObjectState envObject) Creates an environment object in the simulation
void	createEvent(EnvEvent event) Creates an event in the simulation
void	destroyAgent(AgentState agentState) Removes the given agent state
void	destroyEnvObject(EnvObjectState envObjState) Removes the given environment object state
void	loadEnvironmentXML(java.io.File file) Load a new environment to the simulation
void	loadSimulationSnapshot(java.io.File file) Load a simulation snapshot
void	mergeCell(CellID cellID) Merges a cell with its neigboring cell
void	notifySimPropertiesChange() Notifies the simulation configuration settings change
void	pauseSimulation() Pauses the simulation
void	saveEnvironment(java.io.File file) Saves the current simulation environment only
void	saveSimulationSnapshot(java.io.File file) Save a simulation snapshot
void	sendRuntimeAgentCommand(int agentID, RuntimeAgentCommandMsg.RuntimeAgentCommand command, java.lang.Object arg) Sends a runtime agent command to the simulation.
void	sendStateUpdate(VirtualState state) Updates the state of an agent or environment object
void	setReorganizationStrategy(ReorganizationStrategy str) Changes the reorganization strategy to be used in the simulation
void	setupPublications() Adds publication topics to the message broker
void	splitCell(CellID cellID) Splits a cell
void	startSimulation() Starts the simulation

Method Detail

sendRuntimeAgentCommand

void sendRuntimeAgentCommand(int agentID,
                             RuntimeAgentCommandMsg.RuntimeAgentCommand command,
                             java.lang.Object arg)

Sends a runtime agent command to the simulation.

Parameters:

agentID - the id of the agent to which the command is to be applied

command - the command type

arg - any argument or data to be passed along with the command, depending on the command type

createAgent

void createAgent(AgentState agent)

Creates an agent in the simulation.

Parameters:

agent - the agent state of the agent to be created

createEnvObject

void createEnvObject(EnvObjectState envObject)

Creates an environment object in the simulation

Parameters:

envObject - the environment object state of the environment object to be created

createEvent

void createEvent(EnvEvent event)

Creates an event in the simulation

Parameters:

event - the event to be created

sendStateUpdate

void sendStateUpdate(VirtualState state)

Updates the state of an agent or environment object

Parameters:

state - the state to be updated

startSimulation

void startSimulation()

Starts the simulation

pauseSimulation

void pauseSimulation()

Pauses the simulation

addSubscription

void addSubscription(java.lang.String topic,
                     Subscriber subscriber)

Adds a client subscription to the message broker

Parameters:

topic - the topic to be registered for

subscriber - the subscriber handler

setupPublications

void setupPublications()

Adds publication topics to the message broker

setReorganizationStrategy

void setReorganizationStrategy(ReorganizationStrategy str)

Changes the reorganization strategy to be used in the simulation

Parameters:

str - the reorganization strategy

splitCell

void splitCell(CellID cellID)

Splits a cell

Parameters:

cellID - the id of the cell

mergeCell

void mergeCell(CellID cellID)

Merges a cell with its neigboring cell

Parameters:

cellID - the id of the cell

notifySimPropertiesChange

void notifySimPropertiesChange()

Notifies the simulation configuration settings change

saveSimulationSnapshot

void saveSimulationSnapshot(java.io.File file)

Save a simulation snapshot

Parameters:

file - The file the simulation snapshot will be saved to.

loadSimulationSnapshot

void loadSimulationSnapshot(java.io.File file)

Load a simulation snapshot

Parameters:

file - The file the simulation snapshot will be loaded from.

loadEnvironmentXML

void loadEnvironmentXML(java.io.File file)

Load a new environment to the simulation

Parameters:

file - The environment file

saveEnvironment

void saveEnvironment(java.io.File file)

Saves the current simulation environment only

Parameters:

file - The XML file that contains complete information about environment objects

destroyAgent

void destroyAgent(AgentState agentState)

Removes the given agent state

Parameters:

agentState - The agent state to to be destroyed.

destroyEnvObject

void destroyEnvObject(EnvObjectState envObjState)

Removes the given environment object state

Parameters:

envObjState - The environment object state to to be destroyed.