ScanController1D

java.lang.Object
- xal.extension.scan.ScanController1D

public class ScanController1D
extends java.lang.Object

Description of the Class

Constructor Summary

Constructors
Constructor and Description

ScanController1D(java.lang.String title)
Constructor for the ScanController1D object

Constructors
Constructor and Description
`ScanController1D(java.lang.String title)` Constructor for the ScanController1D object

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMeasuredValue(MeasuredValue mv)` Adds a feature to the MeasuredValue attribute of the ScanController1D object
`void`	`addNewPointOfDataListener(java.awt.event.ActionListener newPointListener)` Adds a feature to the NewPointOfDataListener attribute of the ScanController1D object
`void`	`addNewSetOfDataListener(java.awt.event.ActionListener newSetListener)` Adds a feature to the NewSetOfDataListener attribute of the ScanController1D object
`void`	`addResumeListener(java.awt.event.ActionListener newResumeListener)` Adds a new listener to the resume listeners.
`void`	`addStartListener(java.awt.event.ActionListener newStartListener)` Adds a new listener to the start listeners.
`void`	`addStopListener(java.awt.event.ActionListener newStopListener)` Adds a new listener to the stop listeners.
`void`	`addValidationValue(MeasuredValue mv)` Adds a feature to the ValidationValue attribute of the ScanController1D object
`Channel`	`getBeamTriggerChannel()` Returns the beamTriggerChannel attribute of the ScanController1D object
`java.lang.String`	`getBeamTriggerChannelName()` Returns the beamTriggerChannelName attribute of the ScanController1D object
`double`	`getBeamTriggerDelay()` Returns the beamTriggerDelay attribute of the ScanController1D object
`boolean`	`getBeamTriggerState()` Returns the beamTriggerState attribute of the ScanController1D object
`javax.swing.JPanel`	`getJPanel()` Returns the jPanel attribute of the ScanController1D object
`double`	`getLowLimit()` Returns the lowLimit attribute of the ScanController1D object
`java.util.Vector<MeasuredValue>`	`getMeasuredValuesV()` Returns the measuredValuesV attribute of the ScanController1D object
`javax.swing.JTextField`	`getMessageText()` Returns the messageText attribute of the ScanController1D object
`boolean`	`getPhaseScanButtonOn()` Returns the phase scan button state on or off
`boolean`	`getPhaseScanButtonVizible()` Returns true if the phase scan button is visible and false otherwise
`javax.swing.JLabel`	`getScanStep_Label()` Returns the scanStep_Label attribute of the ScanController1D object
`double`	`getScanValue()` Returns the scanValue attribute of the ScanController1D object
`ScanVariable`	`getScanVariable()` Returns the scanVariable attribute of the ScanController1D object
`double`	`getSleepTime()` Returns the sleepTime attribute of the ScanController1D object
`double`	`getStep()` Returns the step attribute of the ScanController1D object
`java.lang.String`	`getTitle()` Returns the title attribute of the ScanController1D object
`javax.swing.JLabel`	`getUnitsLabel()` Returns the unitsLabel attribute of the ScanController1D object
`double`	`getUppLimit()` Returns the uppLimit attribute of the ScanController1D object
`java.util.Vector<MeasuredValue>`	`getValidationValuesV()` Returns the validationValuesV attribute of the ScanController1D object
`javax.swing.JLabel`	`getValueRB_Label()` Returns the valueRB_Label attribute of the ScanController1D object
`javax.swing.JTextField`	`getValueText()` Returns the valueText attribute of the ScanController1D object
`javax.swing.JTextField`	`getValueTextRB()` Returns the valueTextRB attribute of the ScanController1D object
`boolean`	`isContinueON()` Returns the continueON attribute of the ScanController1D object
`boolean`	`isScanON()` Returns the scanON attribute of the ScanController1D object
`static void`	`main(java.lang.String[] args)` Description of the Method
`void`	`measure()` Description of the Method
`void`	`removeAllMeasuredValues()` Description of the Method
`void`	`removeAllNewPointOfDataListeners()` Description of the Method
`void`	`removeAllNewSetOfDataListeners()` Description of the Method
`void`	`removeAllResumeListeners()` Removes all resume listeners.
`void`	`removeAllStartListeners()` Removes all start listeners.
`void`	`removeAllStopListeners()` Removes all stop listeners.
`void`	`removeAllValidationValues()` Description of the Method
`void`	`removeMeasuredValue(MeasuredValue mv)` Description of the Method
`void`	`removeResumeListener(java.awt.event.ActionListener resumeListener)` Removes the listener from the resume listeners.
`void`	`removeStartListener(java.awt.event.ActionListener startListener)` Removes the listener from the start listeners.
`void`	`removeStopListener(java.awt.event.ActionListener stopListener)` Removes the listener from the stop listeners.
`void`	`removeValidationValue(MeasuredValue mv)` Description of the Method
`boolean`	`resumeScan()` Resumes scan
`void`	`setAvgController(AvgController avgController)` Sets the avgController attribute of the ScanController1D object
`void`	`setBeamTriggerChannel(Channel triggerCh)` Sets the beamTriggerChannel attribute of the ScanController1D object
`void`	`setBeamTriggerChannelName(java.lang.String triggerChName)` Sets the beamTriggerChannelName attribute of the ScanController1D object
`void`	`setBeamTriggerDelay(double triggerDelay)` Sets the beamTriggerDelay attribute of the ScanController1D object
`void`	`setBeamTriggerState(boolean triggerOn)` Sets the beamTriggerState attribute of the ScanController1D object
`void`	`setCurrentValue(double scanValue)` Sets the currentValue attribute of the ScanController1D object
`void`	`setCurrentValueRB(double scanValueRB)` Sets the currentValueRB attribute of the ScanController1D object
`void`	`setFontForAll(java.awt.Font fnt)` Sets the fontForAll attribute of the ScanController1D object
`void`	`setLowLimit(double lowLim)` Sets the lowLimit attribute of the ScanController1D object
`void`	`setPhaseScanButtonOn(boolean onOff)` Sets the state of the phase scan button
`void`	`setPhaseScanButtonVisible(boolean vis)` Shows or removes the phase scan button on the pannel
`void`	`setRestoreButton(javax.swing.JCheckBox restoreValueAfterScanButton)` Sets the restoreButton button of the ScanController1D object
`void`	`setScanVariable(ScanVariable scanVariable)` Sets the scanVariable attribute of the ScanController1D object
`void`	`setSleepTime(double sleepTimeIn)` Sets the sleepTime attribute of the ScanController1D object
`void`	`setStep(double step)` Sets the step attribute of the ScanController1D object
`void`	`setTitle(java.lang.String title)` Sets the title attribute of the ScanController1D object
`void`	`setUppLimit(double uppLim)` Sets the uppLimit attribute of the ScanController1D object
`void`	`setValidationController(ValidationController validationController)` Sets the validationController attribute of the ScanController1D object
`boolean`	`startScan()` Starts scan
`boolean`	`stopScan()` Stops scan

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScanController1D
```
public ScanController1D(java.lang.String title)
```
    Constructor for the ScanController1D object
    
    Parameters:
    
    title - Description of the Parameter
- Method Detail
  - setRestoreButton
```
public void setRestoreButton(javax.swing.JCheckBox restoreValueAfterScanButton)
```
    Sets the restoreButton button of the ScanController1D object
    
    Parameters:
    
    restoreValueAfterScanButton - The JCheckBox button
  - setFontForAll
```
public void setFontForAll(java.awt.Font fnt)
```
    Sets the fontForAll attribute of the ScanController1D object
    
    Parameters:
    
    fnt - The new fontForAll value
  - getTitle
```
public java.lang.String getTitle()
```
    Returns the title attribute of the ScanController1D object
    
    Returns:
    
    The title value
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Sets the title attribute of the ScanController1D object
    
    Parameters:
    
    title - The new title value
  - getJPanel
```
public javax.swing.JPanel getJPanel()
```
    Returns the jPanel attribute of the ScanController1D object
    
    Returns:
    
    The jPanel value
  - isScanON
```
public boolean isScanON()
```
    Returns the scanON attribute of the ScanController1D object
    
    Returns:
    
    The scanON value
  - isContinueON
```
public boolean isContinueON()
```
    Returns the continueON attribute of the ScanController1D object
    
    Returns:
    
    The continueON value
  - setScanVariable
```
public void setScanVariable(ScanVariable scanVariable)
```
    Sets the scanVariable attribute of the ScanController1D object
    
    Parameters:
    
    scanVariable - The new scanVariable value
  - setAvgController
```
public void setAvgController(AvgController avgController)
```
    Sets the avgController attribute of the ScanController1D object
    
    Parameters:
    
    avgController - The new avgController value
  - setValidationController
```
public void setValidationController(ValidationController validationController)
```
    Sets the validationController attribute of the ScanController1D object
    
    Parameters:
    
    validationController - The new validationController value
  - setCurrentValue
```
public void setCurrentValue(double scanValue)
```
    Sets the currentValue attribute of the ScanController1D object
    
    Parameters:
    
    scanValue - The new currentValue value
  - setCurrentValueRB
```
public void setCurrentValueRB(double scanValueRB)
```
    Sets the currentValueRB attribute of the ScanController1D object
    
    Parameters:
    
    scanValueRB - The new currentValueRB value
  - setLowLimit
```
public void setLowLimit(double lowLim)
```
    Sets the lowLimit attribute of the ScanController1D object
    
    Parameters:
    
    lowLim - The new lowLimit value
  - setUppLimit
```
public void setUppLimit(double uppLim)
```
    Sets the uppLimit attribute of the ScanController1D object
    
    Parameters:
    
    uppLim - The new uppLimit value
  - setStep
```
public void setStep(double step)
```
    Sets the step attribute of the ScanController1D object
    
    Parameters:
    
    step - The new step value
  - getLowLimit
```
public double getLowLimit()
```
    Returns the lowLimit attribute of the ScanController1D object
    
    Returns:
    
    The lowLimit value
  - getUppLimit
```
public double getUppLimit()
```
    Returns the uppLimit attribute of the ScanController1D object
    
    Returns:
    
    The uppLimit value
  - getStep
```
public double getStep()
```
    Returns the step attribute of the ScanController1D object
    
    Returns:
    
    The step value
  - setSleepTime
```
public void setSleepTime(double sleepTimeIn)
```
    Sets the sleepTime attribute of the ScanController1D object
    
    Parameters:
    
    sleepTimeIn - The new sleepTime value
  - getSleepTime
```
public double getSleepTime()
```
    Returns the sleepTime attribute of the ScanController1D object
    
    Returns:
    
    The sleepTime value
  - getScanVariable
```
public ScanVariable getScanVariable()
```
    Returns the scanVariable attribute of the ScanController1D object
    
    Returns:
    
    The scanVariable value
  - getScanValue
```
public double getScanValue()
```
    Returns the scanValue attribute of the ScanController1D object
    
    Returns:
    
    The scanValue value
  - addMeasuredValue
```
public void addMeasuredValue(MeasuredValue mv)
```
    Adds a feature to the MeasuredValue attribute of the ScanController1D object
    
    Parameters:
    
    mv - The feature to be added to the MeasuredValue attribute
  - getMeasuredValuesV
```
public java.util.Vector<MeasuredValue> getMeasuredValuesV()
```
    Returns the measuredValuesV attribute of the ScanController1D object
    
    Returns:
    
    The measuredValuesV value
  - removeMeasuredValue
```
public void removeMeasuredValue(MeasuredValue mv)
```
    Description of the Method
    
    Parameters:
    
    mv - Description of the Parameter
  - removeAllMeasuredValues
```
public void removeAllMeasuredValues()
```
    Description of the Method
  - addValidationValue
```
public void addValidationValue(MeasuredValue mv)
```
    Adds a feature to the ValidationValue attribute of the ScanController1D object
    
    Parameters:
    
    mv - The feature to be added to the ValidationValue attribute
  - getValidationValuesV
```
public java.util.Vector<MeasuredValue> getValidationValuesV()
```
    Returns the validationValuesV attribute of the ScanController1D object
    
    Returns:
    
    The validationValuesV value
  - removeValidationValue
```
public void removeValidationValue(MeasuredValue mv)
```
    Description of the Method
    
    Parameters:
    
    mv - Description of the Parameter
  - removeAllValidationValues
```
public void removeAllValidationValues()
```
    Description of the Method
  - addNewSetOfDataListener
```
public void addNewSetOfDataListener(java.awt.event.ActionListener newSetListener)
```
    Adds a feature to the NewSetOfDataListener attribute of the ScanController1D object
    
    Parameters:
    
    newSetListener - The feature to be added to the NewSetOfDataListener attribute
  - addNewPointOfDataListener
```
public void addNewPointOfDataListener(java.awt.event.ActionListener newPointListener)
```
    Adds a feature to the NewPointOfDataListener attribute of the ScanController1D object
    
    Parameters:
    
    newPointListener - The feature to be added to the NewPointOfDataListener attribute
  - removeAllNewSetOfDataListeners
```
public void removeAllNewSetOfDataListeners()
```
    Description of the Method
  - removeAllNewPointOfDataListeners
```
public void removeAllNewPointOfDataListeners()
```
    Description of the Method
  - addStartListener
```
public void addStartListener(java.awt.event.ActionListener newStartListener)
```
    Adds a new listener to the start listeners.
    
    Parameters:
    
    newStartListener - New listener
  - removeStartListener
```
public void removeStartListener(java.awt.event.ActionListener startListener)
```
    Removes the listener from the start listeners.
    
    Parameters:
    
    startListener - The listener
  - removeAllStartListeners
```
public void removeAllStartListeners()
```
    Removes all start listeners.
  - addStopListener
```
public void addStopListener(java.awt.event.ActionListener newStopListener)
```
    Adds a new listener to the stop listeners.
    
    Parameters:
    
    newStopListener - New listener
  - removeStopListener
```
public void removeStopListener(java.awt.event.ActionListener stopListener)
```
    Removes the listener from the stop listeners.
    
    Parameters:
    
    stopListener - The listener
  - removeAllStopListeners
```
public void removeAllStopListeners()
```
    Removes all stop listeners.
  - addResumeListener
```
public void addResumeListener(java.awt.event.ActionListener newResumeListener)
```
    Adds a new listener to the resume listeners.
    
    Parameters:
    
    newResumeListener - New listener
  - removeResumeListener
```
public void removeResumeListener(java.awt.event.ActionListener resumeListener)
```
    Removes the listener from the resume listeners.
    
    Parameters:
    
    resumeListener - The listener
  - removeAllResumeListeners
```
public void removeAllResumeListeners()
```
    Removes all resume listeners.
  - startScan
```
public boolean startScan()
```
    Starts scan
    
    Returns:
    
    true if it is possible
  - resumeScan
```
public boolean resumeScan()
```
    Resumes scan
    
    Returns:
    
    true if it is possible
  - stopScan
```
public boolean stopScan()
```
    Stops scan
    
    Returns:
    
    true if it is possible
  - setBeamTriggerState
```
public void setBeamTriggerState(boolean triggerOn)
```
    Sets the beamTriggerState attribute of the ScanController1D object
    
    Parameters:
    
    triggerOn - The new beamTriggerState value
  - setBeamTriggerDelay
```
public void setBeamTriggerDelay(double triggerDelay)
```
    Sets the beamTriggerDelay attribute of the ScanController1D object
    
    Parameters:
    
    triggerDelay - The new beamTriggerDelay value
  - getBeamTriggerState
```
public boolean getBeamTriggerState()
```
    Returns the beamTriggerState attribute of the ScanController1D object
    
    Returns:
    
    The beamTriggerState value
  - getBeamTriggerDelay
```
public double getBeamTriggerDelay()
```
    Returns the beamTriggerDelay attribute of the ScanController1D object
    
    Returns:
    
    The beamTriggerDelay value
  - setBeamTriggerChannel
```
public void setBeamTriggerChannel(Channel triggerCh)
```
    Sets the beamTriggerChannel attribute of the ScanController1D object
    
    Parameters:
    
    triggerCh - The new beamTriggerChannel value
  - setBeamTriggerChannelName
```
public void setBeamTriggerChannelName(java.lang.String triggerChName)
```
    Sets the beamTriggerChannelName attribute of the ScanController1D object
    
    Parameters:
    
    triggerChName - The new beamTriggerChannelName value
  - getBeamTriggerChannel
```
public Channel getBeamTriggerChannel()
```
    Returns the beamTriggerChannel attribute of the ScanController1D object
    
    Returns:
    
    The beamTriggerChannel value
  - getBeamTriggerChannelName
```
public java.lang.String getBeamTriggerChannelName()
```
    Returns the beamTriggerChannelName attribute of the ScanController1D object
    
    Returns:
    
    The beamTriggerChannelName value
  - measure
```
public void measure()
```
    Description of the Method
  - setPhaseScanButtonVisible
```
public void setPhaseScanButtonVisible(boolean vis)
```
    Shows or removes the phase scan button on the pannel
    
    Parameters:
    
    vis - The new phaseScanButtonVisible value
  - getPhaseScanButtonVizible
```
public boolean getPhaseScanButtonVizible()
```
    Returns true if the phase scan button is visible and false otherwise
    
    Returns:
    
    The boolean True if the phase scan button is visible
  - getPhaseScanButtonOn
```
public boolean getPhaseScanButtonOn()
```
    Returns the phase scan button state on or off
    
    Returns:
    
    The phase scan button state on(true) off(false)
  - setPhaseScanButtonOn
```
public void setPhaseScanButtonOn(boolean onOff)
```
    Sets the state of the phase scan button
    
    Parameters:
    
    onOff - The new phase scan button value
  - getValueRB_Label
```
public javax.swing.JLabel getValueRB_Label()
```
    Returns the valueRB_Label attribute of the ScanController1D object
    
    Returns:
    
    The valueRB_Label value
  - getScanStep_Label
```
public javax.swing.JLabel getScanStep_Label()
```
    Returns the scanStep_Label attribute of the ScanController1D object
    
    Returns:
    
    The scanStep_Label value
  - getUnitsLabel
```
public javax.swing.JLabel getUnitsLabel()
```
    Returns the unitsLabel attribute of the ScanController1D object
    
    Returns:
    
    The unitsLabel value
  - getValueText
```
public javax.swing.JTextField getValueText()
```
    Returns the valueText attribute of the ScanController1D object
    
    Returns:
    
    The valueText value
  - getValueTextRB
```
public javax.swing.JTextField getValueTextRB()
```
    Returns the valueTextRB attribute of the ScanController1D object
    
    Returns:
    
    The valueTextRB value
  - getMessageText
```
public javax.swing.JTextField getMessageText()
```
    Returns the messageText attribute of the ScanController1D object
    
    Returns:
    
    The messageText value
  - main
```
public static void main(java.lang.String[] args)
```
    Description of the Method
    
    Parameters:
    
    args - Description of the Parameter

Class ScanController1D

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScanController1D

Method Detail

setRestoreButton

setFontForAll

getTitle

setTitle

getJPanel

isScanON

isContinueON

setScanVariable

setAvgController

setValidationController

setCurrentValue

setCurrentValueRB

setLowLimit

setUppLimit

setStep

getLowLimit

getUppLimit

getStep

setSleepTime

getSleepTime

getScanVariable

getScanValue

addMeasuredValue

getMeasuredValuesV

removeMeasuredValue

removeAllMeasuredValues

addValidationValue

getValidationValuesV

removeValidationValue

removeAllValidationValues

addNewSetOfDataListener

addNewPointOfDataListener

removeAllNewSetOfDataListeners

removeAllNewPointOfDataListeners

addStartListener

removeStartListener

removeAllStartListeners

addStopListener

removeStopListener

removeAllStopListeners

addResumeListener

removeResumeListener

removeAllResumeListeners

startScan

resumeScan

stopScan

setBeamTriggerState

setBeamTriggerDelay

getBeamTriggerState

getBeamTriggerDelay

setBeamTriggerChannel

setBeamTriggerChannelName

getBeamTriggerChannel

getBeamTriggerChannelName

measure

setPhaseScanButtonVisible

getPhaseScanButtonVizible

getPhaseScanButtonOn

setPhaseScanButtonOn

getValueRB_Label

getScanStep_Label

getUnitsLabel

getValueText

getValueTextRB

getMessageText

main