org.robokind.api.vision.messaging

Class RemoteImageServiceClient<Conf>

java.lang.Object

org.robokind.api.common.playable.AbstractPlayable

org.robokind.api.messaging.services.DefaultServiceClient<Conf>

org.robokind.api.vision.messaging.RemoteImageServiceClient<Conf>

All Implemented Interfaces:

Playable, RemoteServiceClient<Conf>, ImageService

public class RemoteImageServiceClient<Conf>
extends 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

Constructors

Constructor and Description

RemoteImageServiceClient(Class<Conf> configClass, String imageServiceId, String remoteId, org.jflux.api.messaging.rk.MessageSender<ServiceCommand> commandSender, org.jflux.api.messaging.rk.MessageSender<Conf> configSender, org.jflux.api.messaging.rk.MessageAsyncReceiver<ServiceError> errorReceiver, ServiceCommandFactory commandFactory, org.jflux.api.messaging.rk.MessageAsyncReceiver<ImageEvent> imageReceiver) Creates a new RemoteImageServiceClients.

Method Summary

Methods

Modifier and Type	Method and Description
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.jflux.api.messaging.rk.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.jflux.api.messaging.rk.MessageSender<ServiceCommand> commandSender,
                        org.jflux.api.messaging.rk.MessageSender<Conf> configSender,
                        org.jflux.api.messaging.rk.MessageAsyncReceiver<ServiceError> errorReceiver,
                        ServiceCommandFactory commandFactory,
                        org.jflux.api.messaging.rk.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 DefaultServiceClient<Conf>

onPause

public boolean onPause(long time)

Overrides:

onPause in class DefaultServiceClient<Conf>

onResume

public boolean onResume(long time)

Overrides:

onResume in class DefaultServiceClient<Conf>

onStart

public boolean onStart(long time)

Overrides:

onStart in class DefaultServiceClient<Conf>

onStop

public boolean onStop(long time)

Overrides:

onStop in class DefaultServiceClient<Conf>

setImageReceiver

public void setImageReceiver(org.jflux.api.messaging.rk.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