Class DummyKeithley2600SweepMode
java.lang.Object
gda.factory.ConfigurableBase
gda.factory.FindableConfigurableBase
gda.device.DeviceBase
gda.device.scannable.ScannableBase
uk.ac.diamond.daq.devices.keithley.AbstractKeithley2600Series
uk.ac.diamond.daq.devices.keithley.DummyKeithley2600Series
uk.ac.diamond.daq.devices.keithley.DummyKeithley2600SweepMode
- All Implemented Interfaces:
Detector,NexusDetector,Device,Scannable,Configurable,Findable,gda.observable.IObservable
-
Nested Class Summary
Nested classes/interfaces inherited from class uk.ac.diamond.daq.devices.keithley.AbstractKeithley2600Series
AbstractKeithley2600Series.ResistanceMode, AbstractKeithley2600Series.SourceMode, AbstractKeithley2600Series.Status -
Field Summary
Fields inherited from class uk.ac.diamond.daq.devices.keithley.AbstractKeithley2600Series
CURRENT_LEVEL_SETPOINT, dataMapToWrite, detectorDataEntryMap, DWELL_TIME, INTEGRATION_TIME, isFirstPoint, limitStatus, MEAN_CURRENT, MEAN_VOLTAGE, NUMBER_OF_READINGS, RESISTANCE_MODE, setting, SOURCE_MODE, switchOnAtNextMove, VOLTAGE_LEVEL_SETPOINTFields inherited from class gda.device.scannable.ScannableBase
__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormatFields inherited from class gda.device.DeviceBase
DEFAULT_PROTECTION_LEVEL_PROPERTYFields inherited from interface gda.device.Scannable
ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidTells the detector to begin to collect a set of data, then returns immediately.voidDefault implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.booleanReturns a value which indicates whether the detector creates its own files.voidMethod called at the end of collection to tell detector when a scan has finished.doubleReturns the time, in seconds, the detector collects for during the next call to collectData()int[]Returns the dimensions of the data object returned by theDetector.readout()method.protected NexusTreeProviderintReturns the current collecting state of the device.voidMethod called before a scan starts.readout()Returns the latest data collected as well as general detector informationvoidsetCollectionTime(double time) Sets the collection time, in seconds, to be used during the next call of collectData.protected voidsetDetectorDataEntryMap(HashMap<?, ?>... data) Returns a string representation of the Scannable and its current position/value/statusvoidReturns when operation carried out by moveTo has completedMethods inherited from class uk.ac.diamond.daq.devices.keithley.DummyKeithley2600Series
getActualCurrent, getActualResistance, getActualVoltage, getDemandCurrent, getDemandVoltage, getIntegrationTime, getResistanceMode, getSourceMode, isOutputOn, outputOff, outputOn, setOutputDemandAndWaitToSettle, setResistanceMode, setSourceModeMethods inherited from class uk.ac.diamond.daq.devices.keithley.AbstractKeithley2600Series
atPointEnd, atScanStart, checkStatusAndThrow, getAdditionalFirstPointSettleTimeMs, getDemand, getFileStructure, getResistanceModes, getSettleTime, getSourceModes, getSwitchOnDelayTimeMs, isBusy, rawAsynchronousMoveTo, rawGetPosition, setAdditionalFirstPointSettleTimeMs, setResistanceMode, setSettleTime, setSourceMode, setSwitchOnDelayTimeMs, setupNamesAndFormat, stop, waitForSettling, waitForSwitchOnMethods inherited from class gda.device.scannable.ScannableBase
__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, checkPositionValid, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusyMethods inherited from class gda.device.DeviceBase
addIObserver, close, deleteIObserver, deleteIObservers, getAttribute, getName, getProtectionLevel, isBeingObserved, isConfigureAtStartup, notifyIObservers, setAttribute, setConfigureAtStartup, setName, setProtectionLevelMethods inherited from class gda.factory.ConfigurableBase
isConfigured, reconfigure, setConfiguredMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface gda.factory.Configurable
isConfigureAtStartup, isConfigured, reconfigureMethods inherited from interface gda.device.Detector
getFileStructureMethods inherited from interface gda.device.Device
close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevelMethods inherited from interface gda.observable.IObservable
addIObserver, deleteIObserver, deleteIObserversMethods inherited from interface gda.device.Scannable
asynchronousMoveTo, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, checkPositionValid, getExtraNames, getInputNames, getLevel, getOutputFormat, getPosition, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, isAt, isBusy, moveTo, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, stop
-
Constructor Details
-
DummyKeithley2600SweepMode
public DummyKeithley2600SweepMode()
-
-
Method Details
-
configure
Description copied from class:ConfigurableBaseDefault implementation for classes that do not have to do any specific configuration.
Classes that do their own configuration should *not* call this superclass function, as it may cause the object to appear configured before it really is.- Specified by:
configurein interfaceConfigurable- Overrides:
configurein classAbstractKeithley2600Series- Throws:
FactoryException- if there is an error in configuration e.g. required variable not set or cannot connect to device
-
toFormattedString
Description copied from interface:ScannableReturns a string representation of the Scannable and its current position/value/statusTypically should return:
name : position
or for detectors, name : status
If the position/status cannot be determined, the function should return
Scannable.VALUE_UNAVAILABLEin its place.- Specified by:
toFormattedStringin interfaceScannable- Overrides:
toFormattedStringin classAbstractKeithley2600Series- Returns:
- string as defined above
-
collectData
Description copied from interface:DetectorTells the detector to begin to collect a set of data, then returns immediately. Should cause the hardware to start collecting immediately: if there is any delay then detectors used in the same scan would collect over different times when beam conditions may differ.- Specified by:
collectDatain interfaceDetector- Throws:
DeviceException
-
setCollectionTime
Description copied from interface:DetectorSets the collection time, in seconds, to be used during the next call of collectData.- Specified by:
setCollectionTimein interfaceDetector- Parameters:
time- the collection time in seconds- Throws:
DeviceException
-
getCollectionTime
Description copied from interface:DetectorReturns the time, in seconds, the detector collects for during the next call to collectData()- Specified by:
getCollectionTimein interfaceDetector- Returns:
- double
- Throws:
DeviceException
-
getStatus
Description copied from interface:DetectorReturns the current collecting state of the device.- Specified by:
getStatusin interfaceDetector- Returns:
- BUSY if the detector has not finished the requested operation(s), IDLE if in an completely idle state and STANDBY if temporarily suspended.
- Throws:
DeviceException
-
getDataDimensions
Description copied from interface:DetectorReturns the dimensions of the data object returned by theDetector.readout()method.- Specified by:
getDataDimensionsin interfaceDetector- Returns:
- the dimensions of the data object returned by the
Detector.readout()method - Throws:
DeviceException
-
prepareForCollection
Description copied from interface:DetectorMethod called before a scan starts. May be used to setup detector for collection, for example MAR345 uses this to erase.Note: it is recommended to not implement this method, but to implement one or both of
Scannable.atScanLineStart()orScannable.atScanStart()instead. Implementing this method may cause issues when the detector class is used in multi-dimensional scans.- Specified by:
prepareForCollectionin interfaceDetector- Throws:
DeviceException
-
endCollection
Description copied from interface:DetectorMethod called at the end of collection to tell detector when a scan has finished. Typically integrating detectors used in powder diffraction do not output until the end of the scan and need to be told when this happens.- Specified by:
endCollectionin interfaceDetector- Throws:
DeviceException
-
createsOwnFiles
Description copied from interface:DetectorReturns a value which indicates whether the detector creates its own files. If it does (return true) the readout() method returns the name of the latest file created as a string. If it does not (return false) the readout() method will return the data directly.- Specified by:
createsOwnFilesin interfaceDetector- Returns:
- true if readout() returns filenames
- Throws:
DeviceException
-
getDescription
- Specified by:
getDescriptionin interfaceDetector- Returns:
- A description of the detector.
- Throws:
DeviceException
-
getDetectorID
- Specified by:
getDetectorIDin interfaceDetector- Returns:
- A identifier for this detector.
- Throws:
DeviceException
-
getDetectorType
- Specified by:
getDetectorTypein interfaceDetector- Returns:
- The type of detector.
- Throws:
DeviceException
-
readout
Description copied from interface:NexusDetectorReturns the latest data collected as well as general detector information- Specified by:
readoutin interfaceDetector- Specified by:
readoutin interfaceNexusDetector- Returns:
- the data collected
- Throws:
DeviceException
-
setDetectorDataEntryMap
- Overrides:
setDetectorDataEntryMapin classAbstractKeithley2600Series- Throws:
DeviceException
-
getDetectorData
- Overrides:
getDetectorDatain classAbstractKeithley2600Series
-
waitWhileBusy
Description copied from class:ScannableBaseReturns when operation carried out by moveTo has completed If this is to be overriden, isBusy must also be valid. Although the pos and scan command currently use this method to determine if the Scannable is busy, this must not be relied upon.- Specified by:
waitWhileBusyin interfaceDetector- Specified by:
waitWhileBusyin interfaceScannable- Overrides:
waitWhileBusyin classAbstractKeithley2600Series- Throws:
DeviceExceptionInterruptedException
-