cz.cuni.amis.pogamut.base.communication.worldview
Interface IWorldChangeEventInput

Package class diagram package IWorldChangeEventInput
All Superinterfaces:
IComponent
All Known Subinterfaces:
ILocalWorldView, ILockableVisionWorldView, ILockableWorldView, IVisionLocalWorldView, IVisionWorldView, IWorldView
All Known Implementing Classes:
AbstractLocalWorldView, AbstractWorldView, BatchAwareLocalWorldView, BatchAwareWorldView, EventDrivenLocalWorldView, EventDrivenWorldView, LocalWorldViewAdapter, LockableBatchAwareWorldView, LockableWorldView, SyncLockableBatchAwareWorldView, VisionLocalWorldView, VisionWorldView

public interface IWorldChangeEventInput
extends IComponent

Input interface for the world view. IWorldView receives new events through this interface.

Author:
Jimmy

Method Summary
 void notify(IWorldChangeEvent event)
          New event was generated from the world.
 void notifyAfterPropagation(IWorldChangeEvent event)
          Raise another event after current one finishes its propagation.
 void notifyImmediately(IWorldChangeEvent event)
          Notify immediately will process the event right away, it won't use "event recursion buffer" to postpone the processing of the event.
 
Methods inherited from interface cz.cuni.amis.pogamut.base.component.IComponent
getComponentId
 

Method Detail

notify

void notify(IWorldChangeEvent event)
            throws ComponentNotRunningException,
                   ComponentPausedException
New event was generated from the world.

Parameters:
event -
Throws:
ComponentNotRunningException
ComponentPausedException

notifyAfterPropagation

void notifyAfterPropagation(IWorldChangeEvent event)
                            throws ComponentNotRunningException,
                                   ComponentPausedException
Raise another event after current one finishes its propagation.

Won't propagate the event if the world view is locked!.

Parameters:
event -
Throws:
ComponentNotRunningException
ComponentPausedException

notifyImmediately

void notifyImmediately(IWorldChangeEvent event)
                       throws ComponentNotRunningException,
                              ComponentPausedException
Notify immediately will process the event right away, it won't use "event recursion buffer" to postpone the processing of the event.

This will work even if the world view is locked!

Parameters:
event -
Throws:
ComponentNotRunningException
ComponentPausedException


Copyright © 2012 AMIS research group, Faculty of Mathematics and Physics, Charles University in Prague, Czech Republic. All Rights Reserved.