org.robokind.api.vision.messaging

Class RemoteImageRegionServiceClient<Conf>

java.lang.Object

org.robokind.api.common.playable.AbstractPlayable

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

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

All Implemented Interfaces:

Playable, RemoteServiceClient<Conf>, ImageRegionService

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

Constructors

Constructor and Description

RemoteImageRegionServiceClient(Class<Conf> configClass, String imageRegionsServiceId, 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<ImageRegionList> regionsReceiver) Creates a new RemoteImageServiceClients.

Method Summary

Methods

Modifier and Type	Method and Description
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.jflux.api.messaging.rk.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.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<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 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>

setImageRegionsReceiver

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