Package org.eclipse.scanning.api.scan.event

Class PositionDelegate

java.lang.Object

org.eclipse.scanning.api.scan.event.PositionDelegate

public class PositionDelegate
extends Object

Manages position listeners.

Constructor Summary

Constructors

Constructor	Description
PositionDelegate(IPublisher<Location> publisher, INameable device)
PositionDelegate(INameable device)

Method Summary

Modifier and Type	Method	Description
void	addPositionListener(IPositionListener listener)
void	fireLevelPerformed(int level, List<? extends ILevel> levels, IPosition position)
void	firePositionChanged(int finalLevel, IPosition position)
void	firePositionPerformed(int finalLevel, IPosition position)
boolean	firePositionWillPerform(IPosition position)
IPublisher<Location>	getPublisher()
void	removePositionListener(IPositionListener listener)
void	setPublisher(IPublisher<Location> publisher)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PositionDelegate

public PositionDelegate(INameable device)

PositionDelegate

public PositionDelegate(IPublisher<Location> publisher,
 INameable device)

Parameters:

publisher - to send events to, may be null.

Method Details

firePositionWillPerform

public boolean firePositionWillPerform(IPosition position)
                                throws ScanningException

Throws:

ScanningException

firePositionChanged

public void firePositionChanged(int finalLevel,
 IPosition position)
                         throws ScanningException

Throws:

ScanningException

firePositionPerformed

public void firePositionPerformed(int finalLevel,
 IPosition position)
                           throws ScanningException

Throws:

ScanningException

fireLevelPerformed

public void fireLevelPerformed(int level,
 List<? extends ILevel> levels,
 IPosition position)
                        throws ScanningException

Throws:

ScanningException

addPositionListener

public void addPositionListener(IPositionListener listener)

removePositionListener

public void removePositionListener(IPositionListener listener)

getPublisher

public IPublisher<Location> getPublisher()

setPublisher

public void setPublisher(IPublisher<Location> publisher)