Package gda.device.detector.countertimer

Class CounterTimerBase

java.lang.Object

gda.factory.ConfigurableBase

gda.factory.FindableConfigurableBase

gda.device.DeviceBase

gda.device.scannable.ScannableBase

gda.device.detector.DetectorBase

gda.device.detector.countertimer.CounterTimerBase

All Implemented Interfaces:

CounterTimer, Detector, Device, Scannable, Configurable, Findable, gda.observable.IObservable, Serializable

Direct Known Subclasses:

TFGCounterTimer

public abstract class CounterTimerBase
extends DetectorBase
implements CounterTimer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	slave
protected Timer	timer

Fields inherited from class gda.device.detector.DetectorBase

collectionTime

Fields inherited from class gda.device.scannable.ScannableBase

__doc__, DEFAULT_INPUT_NAME, DEFAULT_OUTPUT_FORMAT, extraNames, inputNames, level, outputFormat

Fields inherited from class gda.device.DeviceBase

DEFAULT_PROTECTION_LEVEL_PROPERTY

Fields inherited from interface gda.device.Detector

BUSY, FAULT, IDLE, MONITORING, PAUSED, STANDBY

Fields inherited from interface gda.device.Scannable

ATTR_NEXUS_CATEGORY, ATTR_NX_CLASS, DEFAULT_INPUT_NAME, VALUE_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
CounterTimerBase()

Method Summary

Modifier and Type	Method	Description
void	addFrameSet(int frameCount, double requestedLiveTime, double requestedDeadTime)	For a time framing counter-timer a single frameSet object is created for a specified live and dead time.
void	addFrameSet(int frameCount, double requestedLiveTime, double requestedDeadTime, int deadPort, int livePort, int deadPause, int livePause)	For a time framing counter-timer a single frameSet object is created for a specified live and dead time.
void	clearFrameSets()	For a time framing counter-timer all current frameSets are cleared.
void	configure()	Default 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.
int	getCurrentCycle()	For a time framing counter-timer, this returns the current cycle number.
int	getCurrentFrame()	For a time framing counter-timer, this returns the current frame number pointer.
int	getMaximumFrames()	For a time framing counter-timer, this returns the total number of frame pairs supported (each specifying a live and a dead period).
int	getStatus()	Returns the current collecting state of the device.
Timer	getTimer()
String	getTimerName()
boolean	isSlave()	If there are multiple detectors in the same scan operated by the same Timer then only one CounterTimer object should drive the Timer class.
void	loadFrameSets()	For a time framing counter-timer an array of frameSets obtained from calls to makeFrameSet() is loaded into the counter-timer.
void	restart()	For a time framing counter-timer this restarts framing, from the paused state.
void	setCycles(int cycles)	For a time framing counter-timer this sets the number of times the counter-timer cycles through the framesets.
void	setSlave(boolean slave)
void	setTimer(Timer tfg)
void	setTimerName(String tfgName)
void	start()	For a time framing counter-timer this initiates framing.
void	stop()	Stop the current move/operation.

Methods inherited from class gda.device.detector.DetectorBase

asynchronousMoveTo, checkPositionValid, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getPosition, isBusy, prepareForCollection, setCollectionTime, toFormattedString

Methods inherited from class gda.device.scannable.ScannableBase

__call__, __call__, __doc__, __getitem__, __len__, __repr__, __str__, atCommandFailure, atLevelEnd, atLevelMoveStart, atLevelStart, atPointEnd, atPointStart, atScanEnd, atScanLineEnd, atScanLineStart, atScanStart, externalToInternal, getExtraNames, getInputNames, getLevel, getOutputFormat, getScanMetadataAttribute, getScanMetadataAttributeNames, getScanMetadataAttributes, internalToExternal, isAt, moveTo, rawAsynchronousMoveTo, rawGetPosition, setExtraNames, setInputNames, setLevel, setOutputFormat, setScanMetadataAttribute, setScanMetadataAttributes, throwExceptionIfInvalidTarget, toString, validateScannable, valueUnavailableString, waitWhileBusy, waitWhileBusy

Methods inherited from class gda.device.DeviceBase

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

Methods inherited from class gda.factory.ConfigurableBase

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

isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.device.CounterTimer

readChannel, readFrame

Methods inherited from interface gda.device.Detector

collectData, createsOwnFiles, endCollection, getCollectionTime, getDataDimensions, getDescription, getDetectorID, getDetectorType, getFileStructure, prepareForCollection, readout, setCollectionTime, waitWhileBusy

Methods inherited from interface gda.device.Device

close, getAttribute, getProtectionLevel, setAttribute, setProtectionLevel

Methods inherited from interface gda.factory.Findable

getName, setName

Methods inherited from interface gda.observable.IObservable

addIObserver, deleteIObserver, deleteIObservers

Methods 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, toFormattedString

Field Details

slave

protected boolean slave

timer

protected Timer timer

Constructor Details

CounterTimerBase

public CounterTimerBase()

Method Details

configure

public void configure()
               throws FactoryException

Description copied from class: ConfigurableBase

Default 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:

configure in interface Configurable

Overrides:

configure in class ConfigurableBase

Throws:

FactoryException - if there is an error in configuration e.g. required variable not set or cannot connect to device

isSlave

public boolean isSlave()

Description copied from interface: CounterTimer

If there are multiple detectors in the same scan operated by the same Timer then only one CounterTimer object should drive the Timer class. In that case the other CounterTimers should have their slave flag set to true.

Specified by:

isSlave in interface CounterTimer

Returns:

true if the underlying

setSlave

public void setSlave(boolean slave)

Specified by:

setSlave in interface CounterTimer

Parameters:

slave -

getMaximumFrames

public int getMaximumFrames()
                     throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer, this returns the total number of frame pairs supported (each specifying a live and a dead period).

Specified by:

getMaximumFrames in interface CounterTimer

Returns:

maximum number of time frames available

Throws:

DeviceException

getCurrentFrame

public int getCurrentFrame()
                    throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer, this returns the current frame number pointer. During counting this can give an idea of progress.

Specified by:

getCurrentFrame in interface CounterTimer

Returns:

the current frame counter number (1st=0)

Throws:

DeviceException

getCurrentCycle

public int getCurrentCycle()
                    throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer, this returns the current cycle number. During counting this can give an idea of progress. If not implemented this should return a default of 1.

Specified by:

getCurrentCycle in interface CounterTimer

Returns:

the current cycle number

Throws:

DeviceException

setCycles

public void setCycles(int cycles)
               throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer this sets the number of times the counter-timer cycles through the framesets. Default is 1 if h/w does not allow the implementation.

Specified by:

setCycles in interface CounterTimer

Parameters:

cycles - sets the cycle count to the specified number

Throws:

DeviceException

addFrameSet

public void addFrameSet(int frameCount,
 double requestedLiveTime,
 double requestedDeadTime)
                 throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer a single frameSet object is created for a specified live and dead time. A count for identical frames is specified by the frameCount.

Specified by:

addFrameSet in interface CounterTimer

Parameters:

frameCount - number of frames required of this type

requestedLiveTime - frame live time in milliseconds

requestedDeadTime - frame dead time in milliseconds

Throws:

DeviceException

addFrameSet

public void addFrameSet(int frameCount,
 double requestedLiveTime,
 double requestedDeadTime,
 int deadPort,
 int livePort,
 int deadPause,
 int livePause)
                 throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer a single frameSet object is created for a specified live and dead time. A count for identical frames is specified by the frameCount.

Specified by:

addFrameSet in interface CounterTimer

Parameters:

frameCount - requested number of frames required of this type

requestedLiveTime - requested frame live time in milliseconds

requestedDeadTime - requested frame dead time in milliseconds

deadPort - wait period output level 0 or 1

livePort - run period output level 0 or 1

deadPause - pause before wait period 0 or 1

livePause - pause before run period 0 or 1

Throws:

DeviceException

clearFrameSets

public void clearFrameSets()
                    throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer all current frameSets are cleared.

Specified by:

clearFrameSets in interface CounterTimer

Throws:

DeviceException

loadFrameSets

public void loadFrameSets()
                   throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer an array of frameSets obtained from calls to makeFrameSet() is loaded into the counter-timer. The current mode specified in setMode() is used to create the real frames before actual loading to the timer.

Specified by:

loadFrameSets in interface CounterTimer

Throws:

DeviceException

restart

public void restart()
             throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer this restarts framing, from the paused state.

Specified by:

restart in interface CounterTimer

Throws:

DeviceException

start

public void start()
           throws DeviceException

Description copied from interface: CounterTimer

For a time framing counter-timer this initiates framing.

Specified by:

start in interface CounterTimer

Throws:

DeviceException

stop

public void stop()
          throws DeviceException

Description copied from class: ScannableBase

Stop the current move/operation. Default behaviour is to do nothing. Inheriting classes have the option to implement this if their specific behaviour requires it.

Specified by:

stop in interface Scannable

Overrides:

stop in class ScannableBase

Throws:

DeviceException

See Also:

• Scannable.stop()

getStatus

public int getStatus()
              throws DeviceException

Description copied from interface: Detector

Returns the current collecting state of the device.

Specified by:

getStatus in interface Detector

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

See Also:

• Detector.getStatus()

setTimerName

public void setTimerName(String tfgName)

getTimerName

public String getTimerName()

getTimer

public Timer getTimer()

setTimer

public void setTimer(Timer tfg)