org.robokind.api.vision.messaging
Class RemoteImageRegionServiceClient<Conf>

java.lang.Object
  extended by org.robokind.api.common.playable.AbstractPlayable
      extended by org.robokind.api.messaging.services.DefaultServiceClient<Conf>
          extended by org.robokind.api.vision.messaging.RemoteImageRegionServiceClient<Conf>
All Implemented Interfaces:
org.robokind.api.common.playable.Playable, org.robokind.api.messaging.services.RemoteServiceClient<Conf>, ImageRegionService

public class RemoteImageRegionServiceClient<Conf>
extends org.robokind.api.messaging.services.DefaultServiceClient<Conf>
implements ImageRegionService

Connects to a remote ImageService through Messaging components.

Author:
Matthew Stevenson

Field Summary
 
Fields inherited from class org.robokind.api.common.playable.AbstractPlayable
myElapsedPauseTime, myPauseTime, myPlayableListeners, myPlayState, myResumeTime, myStartTime, myStopTime
 
Fields inherited from interface org.robokind.api.vision.ImageRegionService
PROP_ID
 
Constructor Summary
RemoteImageRegionServiceClient(Class<Conf> configClass, String imageRegionsServiceId, String remoteId, org.robokind.api.messaging.MessageSender<org.robokind.api.messaging.services.ServiceCommand> commandSender, org.robokind.api.messaging.MessageSender<Conf> configSender, org.robokind.api.messaging.MessageAsyncReceiver<org.robokind.api.messaging.services.ServiceError> errorReceiver, org.robokind.api.messaging.services.ServiceCommandFactory commandFactory, org.robokind.api.messaging.MessageAsyncReceiver<ImageRegionList> regionsReceiver)
          Creates a new RemoteImageServiceClients.
 
Method Summary
 void addImageRegionsListener(org.jflux.api.core.Listener<ImageRegionList> listener)
          Adds a Listener to be notified when an ImageRegionList is received.
 String getImageServiceId()
          Returns the ImageRegionService Id.
 boolean onComplete(long time)
           
 boolean onPause(long time)
           
 boolean onResume(long time)
           
 boolean onStart(long time)
           
 boolean onStop(long time)
           
 void removeImageRegionsListener(org.jflux.api.core.Listener<ImageRegionList> listener)
          Removes a Listener from being notified when an ImageRegionList is received.
 void setImageRegionsReceiver(org.robokind.api.messaging.MessageAsyncReceiver<ImageRegionList> receiver)
           
 void start()
          Starts the ImageRegionService.
 void stop()
          Stops the ImageRegionService.
 
Methods inherited from class org.robokind.api.messaging.services.DefaultServiceClient
getClientId, getHostId, initialize, send, setCommandFactory, setCommandSender, setConfigSender, setErrorReceiver
 
Methods inherited from class org.robokind.api.common.playable.AbstractPlayable
addPlayableListener, afterComplete, complete, firePlayStateChanged, getElapsedPauseTime, getElapsedPlayTime, getPauseTime, getPlayState, getResumeTime, getStartTime, getStopTime, pause, removePlayableListener, resume, start, stop
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.robokind.api.common.playable.Playable
addPlayableListener, complete, getElapsedPauseTime, getElapsedPlayTime, getPauseTime, getPlayState, getResumeTime, getStartTime, getStopTime, pause, removePlayableListener, resume, start, stop
 

Constructor Detail

RemoteImageRegionServiceClient

public RemoteImageRegionServiceClient(Class<Conf> configClass,
                                      String imageRegionsServiceId,
                                      String remoteId,
                                      org.robokind.api.messaging.MessageSender<org.robokind.api.messaging.services.ServiceCommand> commandSender,
                                      org.robokind.api.messaging.MessageSender<Conf> configSender,
                                      org.robokind.api.messaging.MessageAsyncReceiver<org.robokind.api.messaging.services.ServiceError> errorReceiver,
                                      org.robokind.api.messaging.services.ServiceCommandFactory commandFactory,
                                      org.robokind.api.messaging.MessageAsyncReceiver<ImageRegionList> regionsReceiver)
Creates a new RemoteImageServiceClients. Call start() to start the service.

Parameters:
configClass -
imageRegionsServiceId -
remoteId -
commandSender -
configSender -
errorReceiver -
commandFactory -
regionsReceiver -
Method Detail

getImageServiceId

public String getImageServiceId()
Description copied from interface: ImageRegionService
Returns the ImageRegionService Id.

Specified by:
getImageServiceId in interface ImageRegionService
Returns:
ImageRegionService Id

start

public void start()
Description copied from interface: ImageRegionService
Starts the ImageRegionService.

Specified by:
start in interface ImageRegionService

stop

public void stop()
Description copied from interface: ImageRegionService
Stops the ImageRegionService.

Specified by:
stop in interface ImageRegionService

onComplete

public boolean onComplete(long time)
Overrides:
onComplete in class org.robokind.api.messaging.services.DefaultServiceClient<Conf>

onPause

public boolean onPause(long time)
Overrides:
onPause in class org.robokind.api.messaging.services.DefaultServiceClient<Conf>

onResume

public boolean onResume(long time)
Overrides:
onResume in class org.robokind.api.messaging.services.DefaultServiceClient<Conf>

onStart

public boolean onStart(long time)
Overrides:
onStart in class org.robokind.api.messaging.services.DefaultServiceClient<Conf>

onStop

public boolean onStop(long time)
Overrides:
onStop in class org.robokind.api.messaging.services.DefaultServiceClient<Conf>

setImageRegionsReceiver

public void setImageRegionsReceiver(org.robokind.api.messaging.MessageAsyncReceiver<ImageRegionList> receiver)

addImageRegionsListener

public void addImageRegionsListener(org.jflux.api.core.Listener<ImageRegionList> listener)
Description copied from interface: ImageRegionService
Adds a Listener to be notified when an ImageRegionList is received.

Specified by:
addImageRegionsListener in interface ImageRegionService
Parameters:
listener - the Listener to be notified

removeImageRegionsListener

public void removeImageRegionsListener(org.jflux.api.core.Listener<ImageRegionList> listener)
Description copied from interface: ImageRegionService
Removes a Listener from being notified when an ImageRegionList is received.

Specified by:
removeImageRegionsListener in interface ImageRegionService
Parameters:
listener - the Listener to remove


Copyright © 2011-2013. All Rights Reserved.