Package gda.device.scannable

Class ProcessingScannable

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.AbstractScanHook

gda.device.scannable.ProcessingScannable

All Implemented Interfaces:

Device, ProcessingRequestProvider, Scannable, Configurable, Findable, gda.observable.IObservable

public class ProcessingScannable
extends AbstractScanHook
implements ProcessingRequestProvider

A scannable that provides a configurable processing request. Takes no other actions in scan

Field Summary

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
ProcessingScannable(String name)

Method Summary

Modifier and Type	Method	Description
void	__delitem__(String process)	Python method to remove a processing entry
Collection<Object>	__getitem__(String process)	Python method to get processing configuration - returns unmodifiable copy
void	__setitem__(String process, Iterable<Object> config)	Python convenience method for setting processing configurations
void	__setitem__(String process, String config)	Python convenience method for setting processing configuration to a single string
void	addProcessingRequest(String key, Object value)	Add configuration to a previous process, creating one if it doesn't exist
void	clearProcessing()	Remove all configuration
void	clearProcessing(String key)	Remove all configuration for a processing key
Map<String,Collection<Object>>	getProcessingRequest()
void	setProcessingRequest(String key, Object config)	Set the configuration for a processing key (to a list containing a single value) removing any previous configuration for that key
void	setProcessingRequest(String key, Collection<Object> config)	Set the configuration for a processing key removing any previous configuration for that key
void	setProcessingRequest(Map<String,Collection<Object>> newRequest)	Set complete processing request removing any previous configuration

Methods inherited from class gda.device.scannable.AbstractScanHook

asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setName, setOutputFormat, stop, toFormattedString, toString, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setProtectionLevel

Methods inherited from class gda.factory.ConfigurableBase

configure, isConfigured, reconfigure, setConfigured

Methods inherited from class java.lang.Object

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

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods inherited from interface gda.device.Scannable

getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, setScanMetadataAttribute, setScanMetadataAttributes

Constructor Details

ProcessingScannable

public ProcessingScannable(String name)

Method Details

getProcessingRequest

public Map<String,Collection<Object>> getProcessingRequest()

Specified by:

getProcessingRequest in interface ProcessingRequestProvider

setProcessingRequest

public void setProcessingRequest(Map<String,Collection<Object>> newRequest)

Set complete processing request removing any previous configuration

setProcessingRequest

public void setProcessingRequest(String key,
 Collection<Object> config)

Set the configuration for a processing key removing any previous configuration for that key

setProcessingRequest

public void setProcessingRequest(String key,
 Object config)

Set the configuration for a processing key (to a list containing a single value) removing any previous configuration for that key

addProcessingRequest

public void addProcessingRequest(String key,
 Object value)

Add configuration to a previous process, creating one if it doesn't exist

clearProcessing

public void clearProcessing()

Remove all configuration

clearProcessing

public void clearProcessing(String key)

Remove all configuration for a processing key

__getitem__

public Collection<Object> __getitem__(String process)

Python method to get processing configuration - returns unmodifiable copy

__setitem__

public void __setitem__(String process,
 Iterable<Object> config)

Python convenience method for setting processing configurations

 >>> pr['foo'] = ['hello', 'world'] # sets the config for the 'foo' entry
 

__setitem__

public void __setitem__(String process,
 String config)

Python convenience method for setting processing configuration to a single string

 >>> pr['foo'] = 'helloWorld' # sets the config for the 'foo' entry
 >>> pr['foo']
 ['helloWorld']
 >>>
 

__delitem__

public void __delitem__(String process)

Python method to remove a processing entry