cz.cuni.amis.pogamut.usar2004.communication.worldview

Class USAR2004SyncLockableWorldView

java.lang.Object

cz.cuni.amis.pogamut.base.communication.worldview.impl.AbstractWorldView

cz.cuni.amis.pogamut.base.communication.worldview.impl.EventDrivenWorldView

cz.cuni.amis.pogamut.base3d.worldview.impl.VisionWorldView

cz.cuni.amis.pogamut.usar2004.communication.worldview.USAR2004WorldView

cz.cuni.amis.pogamut.usar2004.communication.worldview.USAR2004SyncLockableWorldView

All Implemented Interfaces:

cz.cuni.amis.pogamut.base.communication.worldview.ILockableWorldView, cz.cuni.amis.pogamut.base.communication.worldview.IWorldChangeEventInput, cz.cuni.amis.pogamut.base.communication.worldview.IWorldView, cz.cuni.amis.pogamut.base.component.IComponent, cz.cuni.amis.pogamut.base3d.ILockableVisionWorldView, cz.cuni.amis.pogamut.base3d.worldview.IVisionWorldView

public class USAR2004SyncLockableWorldView
extends USAR2004WorldView
implements cz.cuni.amis.pogamut.base3d.ILockableVisionWorldView

Lockable word view.

Contains GameBots2004 correct locking of the worldview.

All messages are processed always in batches (all messages between EndMessages are one batch) meaning that the world view is always correct!

When worldview is lock()ed it postpones the events until unlock()ed, which is triggering raising all events that came from the lock().

lock() method here blocks until the END message of the batch is hit, then the world view is considered to be fully locked and let the lock() continue. You may use it to create correct sync bot. (just lock() the world view before your logic and unlock() the world view after the logic finishes)

The world view is unlocked from the beginning.

The locking mechanism starts to work with the first BeginMessage. (To let all other events to be processed automatically during the handshake.)

Author:

Jimmy

, Jimmy

See Also:

UT2004LockableWorldView

Field Summary

Fields

Modifier and Type	Field and Description
static String	WORLDVIEW_DEPENDENCY

Fields inherited from class cz.cuni.amis.pogamut.base.communication.worldview.impl.EventDrivenWorldView

notifyEventsList, receiveEventProcessing

Fields inherited from class cz.cuni.amis.pogamut.base.communication.worldview.impl.AbstractWorldView

COMPONENT_ID, control, controller, eventBus, log

Constructor Summary

Constructors

Constructor and Description
USAR2004SyncLockableWorldView(cz.cuni.amis.pogamut.base.component.controller.ComponentDependencies dependencies, cz.cuni.amis.pogamut.base.communication.mediator.IMediator mediator, cz.cuni.amis.pogamut.base.component.bus.IComponentBus bus, cz.cuni.amis.pogamut.base.utils.logging.IAgentLogger log)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isInLock()
boolean	isLocked()
void	lock() When the world view is locked - no batches are processes until unlocked.
void	notify(cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent event) Implements locking logic.
protected void	prePause()
protected void	preStop()
protected void	resume()
protected void	start(boolean startPaused)
protected void	stop()
void	unlock() Unlocks the world view - triggers processing of all events till the last EndMessage that came between lock() / unlock() calls.

Methods inherited from class cz.cuni.amis.pogamut.base3d.worldview.impl.VisionWorldView

addVisibleObject, cleanUp, getAllVisible, getAllVisible, getVisible, getVisible, objectAppeared, objectCreated, objectDestroyed, objectDisappeared, objectUpdatedEvent, removeVisibleObject

Methods inherited from class cz.cuni.amis.pogamut.base.communication.worldview.impl.EventDrivenWorldView

innerNotify, notifyAfterPropagation, notifyImmediately, objectUpdated, raiseEvent

Methods inherited from class cz.cuni.amis.pogamut.base.communication.worldview.impl.AbstractWorldView

addEventListener, addObjectListener, addObjectListener, addObjectListener, addObjectListener, addWorldObject, get, get, get, getAll, getAll, getComponentId, getEventBus, getLog, getSingle, isListening, isListening, isListening, isListening, isListening, isListening, isPaused, isRunning, kill, pause, removeEventListener, removeListener, removeObjectListener, removeObjectListener, removeObjectListener, removeObjectListener, removeWorldObject, reset, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.cuni.amis.pogamut.base3d.worldview.IVisionWorldView

getAllVisible, getAllVisible, getVisible, getVisible

Methods inherited from interface cz.cuni.amis.pogamut.base.communication.worldview.IWorldView

addEventListener, addObjectListener, addObjectListener, addObjectListener, addObjectListener, get, get, get, getAll, getAll, getEventBus, getSingle, isListening, isListening, isListening, isListening, isListening, isListening, removeEventListener, removeListener, removeObjectListener, removeObjectListener, removeObjectListener, removeObjectListener

Methods inherited from interface cz.cuni.amis.pogamut.base.communication.worldview.IWorldChangeEventInput

notifyAfterPropagation, notifyImmediately

Methods inherited from interface cz.cuni.amis.pogamut.base.component.IComponent

getComponentId

Field Detail

WORLDVIEW_DEPENDENCY

public static final String WORLDVIEW_DEPENDENCY

See Also:

Constant Field Values

Constructor Detail

USAR2004SyncLockableWorldView

@Inject
public USAR2004SyncLockableWorldView(cz.cuni.amis.pogamut.base.component.controller.ComponentDependencies dependencies,
                                    cz.cuni.amis.pogamut.base.communication.mediator.IMediator mediator,
                                    cz.cuni.amis.pogamut.base.component.bus.IComponentBus bus,
                                    cz.cuni.amis.pogamut.base.utils.logging.IAgentLogger log)

Method Detail

lock

public void lock()
          throws cz.cuni.amis.utils.exception.PogamutInterruptedException,
                 cz.cuni.amis.pogamut.base.component.bus.exception.ComponentNotRunningException

When the world view is locked - no batches are processes until unlocked.

Specified by:

lock in interface cz.cuni.amis.pogamut.base.communication.worldview.ILockableWorldView

Throws:

cz.cuni.amis.utils.exception.PogamutInterruptedException

cz.cuni.amis.pogamut.base.component.bus.exception.ComponentNotRunningException

unlock

public void unlock()
            throws cz.cuni.amis.pogamut.base.component.bus.exception.ComponentNotRunningException

Unlocks the world view - triggers processing of all events till the last EndMessage that came between lock() / unlock() calls.

Specified by:

unlock in interface cz.cuni.amis.pogamut.base.communication.worldview.ILockableWorldView

Throws:

cz.cuni.amis.pogamut.base.component.bus.exception.ComponentNotRunningException

isLocked

public boolean isLocked()

Specified by:

isLocked in interface cz.cuni.amis.pogamut.base.communication.worldview.ILockableWorldView

isInLock

public boolean isInLock()

notify

public void notify(cz.cuni.amis.pogamut.base.communication.translator.event.IWorldChangeEvent event)

Implements locking logic.

Specified by:

notify in interface cz.cuni.amis.pogamut.base.communication.worldview.IWorldChangeEventInput

Overrides:

notify in class cz.cuni.amis.pogamut.base.communication.worldview.impl.EventDrivenWorldView

start

protected void start(boolean startPaused)

Overrides:

start in class cz.cuni.amis.pogamut.base.communication.worldview.impl.AbstractWorldView

preStop

protected void preStop()

Overrides:

preStop in class cz.cuni.amis.pogamut.base.communication.worldview.impl.AbstractWorldView

prePause

protected void prePause()

Overrides:

prePause in class cz.cuni.amis.pogamut.base.communication.worldview.impl.AbstractWorldView

resume

protected void resume()

Overrides:

resume in class cz.cuni.amis.pogamut.base.communication.worldview.impl.AbstractWorldView

stop

protected void stop()

Overrides:

stop in class cz.cuni.amis.pogamut.base.communication.worldview.impl.AbstractWorldView