org.gscg.gameleader.interactionlayer
Interface RemoteInteractionLayerInterface

All Superinterfaces:

nl.tudelft.simulation.dsol.simulators.DESSSimulatorInterface, java.util.EventListener, nl.tudelft.simulation.event.EventListenerInterface, nl.tudelft.simulation.event.EventProducerInterface, ExperimentInterface, GlobalInteractionLayerInterface, java.rmi.Remote, nl.tudelft.simulation.event.remote.RemoteEventProducerInterface, java.io.Serializable, nl.tudelft.simulation.dsol.simulators.SimulatorInterface

All Known Implementing Classes:

GameLeaderInteractionLayer

public interface RemoteInteractionLayerInterface

extends ExperimentInterface, nl.tudelft.simulation.dsol.simulators.DESSSimulatorInterface, GlobalInteractionLayerInterface

The RemoteInteraction interface defines the methods for the client-side application.
Copyright (c) 2003-2005 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information www.simulation.tudelft.nl . The source code and binary code of this software is proprietary information of Delft University of Technology.

Since:

1.0.0

Version:

$Revision: 1.1 $ $Date: 2005/06/16 12:34:10 $

Author:

Stijn-Pieter van Houten

Field Summary

Fields inherited from interface nl.tudelft.simulation.dsol.simulators.DESSSimulatorInterface

DEFAULT_TIME_STEP, TIME_STEP_CHANGED_EVENT

Fields inherited from interface nl.tudelft.simulation.dsol.simulators.SimulatorInterface

END_OF_REPLICATION_EVENT, START_EVENT, START_REPLICATION_EVENT, STEP_EVENT, STOP_EVENT, TIME_CHANGED_EVENT, WARMUP_EVENT

Fields inherited from interface nl.tudelft.simulation.event.EventProducerInterface

FIRST_POSITION, LAST_POSITION

Method Summary

java.util.Map	getActorKeys()
long	getAnimationDelay()
java.util.Map	getBindings()
IntrospectionData	getIntrospectedObjectData(java.lang.String key) Method getIntrospectedObjectData returns the date of the object which has been introspected on a client-side animationpanel.
void	removeAnimationRefreshDelayListener(nl.tudelft.simulation.event.remote.RemoteEventListenerInterface listener) removes a listener for a refresh delay
void	saveSimulation() saves a simulation to a persitent storage
void	setAnimationDelay(long arg0)
void	setAnimationRefreshDelay(double times, nl.tudelft.simulation.event.remote.RemoteEventListenerInterface listener) sets the refresh delay for the client side animation panel; the server responds with a GameLeaderInteractionLayer.ANIMATION_UPDATE_EVENT
void	updateIntrospectedObject(IntrospectionData data) Method updateIntrospectedObject updates an introspected object.

Methods inherited from interface org.gscg.gameleader.interactionlayer.experiment.ExperimentInterface

parseExperiment

Methods inherited from interface nl.tudelft.simulation.dsol.simulators.DESSSimulatorInterface

getTimeStep, setTimeStep

Methods inherited from interface nl.tudelft.simulation.dsol.simulators.SimulatorInterface

getReplication, getSimulatorTime, initialize, isRunning, start, step, stop

Methods inherited from interface nl.tudelft.simulation.event.EventProducerInterface

addListener, addListener, addListener, addListener, getEventTypes, removeListener

Methods inherited from interface org.gscg.common.interactionlayer.GlobalInteractionLayerInterface

addEventTypeSentByClient, addEventTypeToAnnounceList, getCache, getStatisticEventTypes, getTotalNumberOfDays, login

Methods inherited from interface nl.tudelft.simulation.event.EventListenerInterface

notify

Method Detail

getAnimationDelay

public long getAnimationDelay()
                       throws java.rmi.RemoteException

Returns:

returns the animation delay

Throws:

java.rmi.RemoteException - thrown in case of network failure

setAnimationDelay

public void setAnimationDelay(long arg0)
                       throws java.rmi.RemoteException

Parameters:

arg0 - the animation delay

Throws:

java.rmi.RemoteException - thrown in case of network failure

getBindings

public java.util.Map getBindings()
                          throws java.rmi.RemoteException

Returns:

returns the map with animation bindings

Throws:

java.rmi.RemoteException - thrown in case of network failure

getActorKeys

public java.util.Map getActorKeys()
                           throws java.rmi.RemoteException

Returns:

returns the map with the keys for the actors. A key of the map represents a reference type of an actor, e.g. a manufacturer or a retailer. The object belonging to this key is a alfabetically SortedSet, containing they keys for the actors. These keys can be used to get the data for an actor from the server.

Throws:

java.rmi.RemoteException - thrown in case of network failure

setAnimationRefreshDelay

public void setAnimationRefreshDelay(double times,
                                     nl.tudelft.simulation.event.remote.RemoteEventListenerInterface listener)
                              throws java.rmi.RemoteException

sets the refresh delay for the client side animation panel; the server responds with a GameLeaderInteractionLayer.ANIMATION_UPDATE_EVENT

Parameters:

times - the number of times per second the animation should be refreshed (only if an update is present)

listener - the listener for the event

Throws:

java.rmi.RemoteException - thrown in case of a network error

removeAnimationRefreshDelayListener

public void removeAnimationRefreshDelayListener(nl.tudelft.simulation.event.remote.RemoteEventListenerInterface listener)
                                         throws java.rmi.RemoteException

removes a listener for a refresh delay

Parameters:

listener - the listener to remove

Throws:

java.rmi.RemoteException - thrown in case of network failure

saveSimulation

public void saveSimulation()
                    throws java.rmi.RemoteException

saves a simulation to a persitent storage

Throws:

java.rmi.RemoteException - thrown in case of network failure

getIntrospectedObjectData

public IntrospectionData getIntrospectedObjectData(java.lang.String key)
                                            throws java.rmi.RemoteException

Method getIntrospectedObjectData returns the date of the object which has been introspected on a client-side animationpanel. Serverside resolving of this object is done using a unique key which is a combination of the toString() and hashCode() methods of the object.

Parameters:

key - the key to use

Returns:

Returns the introspected data for the object if found, null otherwise

Throws:

java.rmi.RemoteException - thrown in case of a network failure

updateIntrospectedObject

public void updateIntrospectedObject(IntrospectionData data)
                              throws java.rmi.RemoteException

Method updateIntrospectedObject updates an introspected object.

Parameters:

data - the data for the oject

Throws:

java.rmi.RemoteException - thrown in case of a network failure