org.robokind.api.vision.messaging
Class RemoteImageServiceClient<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.RemoteImageServiceClient<Conf>
All Implemented Interfaces:
org.robokind.api.common.playable.Playable, org.robokind.api.messaging.services.RemoteServiceClient<Conf>, ImageService

public class RemoteImageServiceClient<Conf>
extends org.robokind.api.messaging.services.DefaultServiceClient<Conf>
implements ImageService

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.ImageService
PROP_ID
 
Constructor Summary
RemoteImageServiceClient(Class<Conf> configClass, String imageServiceId, 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<ImageEvent> imageReceiver)
          Creates a new RemoteImageServiceClients.
 
Method Summary
 void addImageListener(org.jflux.api.core.Listener<ImageEvent> listener)
          Adds a Listener to be notified when an image is received.
 String getImageServiceId()
          Returns the ImageService Id.
 boolean onComplete(long time)
           
 boolean onPause(long time)
           
 boolean onResume(long time)
           
 boolean onStart(long time)
           
 boolean onStop(long time)
           
 void removeImageListener(org.jflux.api.core.Listener<ImageEvent> listener)
          Removes a Listener from being notified when an image is received.
 void setImageReceiver(org.robokind.api.messaging.MessageAsyncReceiver<ImageEvent> receiver)
           
 void start()
          Starts the ImageService.
 void stop()
          Stops the ImageService.
 
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

RemoteImageServiceClient

public RemoteImageServiceClient(Class<Conf> configClass,
                                String imageServiceId,
                                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<ImageEvent> imageReceiver)
Creates a new RemoteImageServiceClients. Call start() to start the service.

Parameters:
configClass -
imageServiceId -
remoteId -
commandSender -
configSender -
errorReceiver -
commandFactory -
imageReceiver -
Method Detail

getImageServiceId

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

Specified by:
getImageServiceId in interface ImageService
Returns:
ImageService Id

start

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

Specified by:
start in interface ImageService

stop

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

Specified by:
stop in interface ImageService

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>

setImageReceiver

public void setImageReceiver(org.robokind.api.messaging.MessageAsyncReceiver<ImageEvent> receiver)

addImageListener

public void addImageListener(org.jflux.api.core.Listener<ImageEvent> listener)
Description copied from interface: ImageService
Adds a Listener to be notified when an image is received.

Specified by:
addImageListener in interface ImageService
Parameters:
listener - the Listener to be notified

removeImageListener

public void removeImageListener(org.jflux.api.core.Listener<ImageEvent> listener)
Description copied from interface: ImageService
Removes a Listener from being notified when an image is received.

Specified by:
removeImageListener in interface ImageService
Parameters:
listener - the Listener to remove


Copyright © 2011-2013. All Rights Reserved.