xal.extension.scan.analysis

Class MainAnalysisController

java.lang.Object

xal.extension.scan.analysis.MainAnalysisController

public class MainAnalysisController
extends java.lang.Object

AnalysisController is a class to handle analysis of the scan data.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JPanel	dataReaderPanel Description of the Field

Constructor Summary

Constructors

Constructor and Description

MainAnalysisController(java.lang.Object mainScanDocument_In, javax.swing.JPanel parentAnalysisPanel_In, javax.swing.JPanel analysisControlPanel_In, javax.swing.JPanel customGraphPanel_In, ScanVariable scanVariableParameter_In, ScanVariable scanVariable_In, java.util.Vector<MeasuredValue> measuredValuesV_In, java.util.Vector<java.lang.Boolean> measuredValuesShowStateV_In, FunctionGraphsJPanel graphScan_In, FunctionGraphsJPanel graphAnalysis_In) Constructor.

Method Summary

Modifier and Type	Method and Description
void	createChildAnalysis(DataAdaptor analysisConfig) Creates all custom analysis.
void	dumpChildAnalysisConfig(DataAdaptor analysisConfig) Sets the configurations of the analysis by passing config file to the children.
protected BasicGraphData	getChoosenDraphData() Gets the choosenDraphData attribute of the MainAnalysisController object
protected java.lang.Object[]	getChoosenDraphDataAndPoint() Gets the choosenDraphDataAndPoint attribute of the MainAnalysisController object
javax.swing.JPanel	getDataReaderPanel() Creates all custom analysis.
java.lang.Object	getMainScanDocument() Returns the main scan document reference as Object instance.
static double	getPhaseShift(BasicGraphData gd) Returns the phase shift value for graph
static double	getPhaseShift(java.util.Vector<BasicGraphData> gdV) Returns the average phase shift value for graphs
static java.lang.String	getPhaseShiftKey() Returns the key string for graph properties specifying the x-coordinate phase shift.
void	isGoingShowUp() This method executed when analysis panel showing up.
void	isGoingShutUp() This method executed when analysis panel is about to be shut up.
void	setFontsForAll(java.awt.Font fnt) Sets fonts for all GUI elements.
void	setMessageTextField(javax.swing.JTextField messageTextLocal) Sets local message text field.
void	setScanPVandScanPV_RB_State(boolean scanPV_ShowState, boolean scanPV_RB_ShowState) Sets mask specifying if the data for scan PV scan read back PV should be shown.
void	updateDataSetOnGraphPanel() Updates data on the analysis graph panel.

Methods inherited from class java.lang.Object

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

Field Detail

dataReaderPanel

protected javax.swing.JPanel dataReaderPanel

Description of the Field

Constructor Detail

MainAnalysisController

public MainAnalysisController(java.lang.Object mainScanDocument_In,
                              javax.swing.JPanel parentAnalysisPanel_In,
                              javax.swing.JPanel analysisControlPanel_In,
                              javax.swing.JPanel customGraphPanel_In,
                              ScanVariable scanVariableParameter_In,
                              ScanVariable scanVariable_In,
                              java.util.Vector<MeasuredValue> measuredValuesV_In,
                              java.util.Vector<java.lang.Boolean> measuredValuesShowStateV_In,
                              FunctionGraphsJPanel graphScan_In,
                              FunctionGraphsJPanel graphAnalysis_In)

Constructor. The first parameter is the parent panel. It is used to refresh the whole analysis panel. The second is used to place control elements. The third is used to place custom graph panels and general buttons panel. The 4-th is the scan variable. The 5-th is the vector with MeasuredValues instances. The 6-th includes masks specifying should be shown graphs from MeasuredValues or not. The 7-th is the graph panel to show graph data.

Parameters:

mainScanDocument_In - Description of the Parameter

parentAnalysisPanel_In - Description of the Parameter

analysisControlPanel_In - Description of the Parameter

customGraphPanel_In - Description of the Parameter

scanVariableParameter_In - Description of the Parameter

scanVariable_In - Description of the Parameter

measuredValuesV_In - Description of the Parameter

measuredValuesShowStateV_In - Description of the Parameter

graphScan_In - Description of the Parameter

graphAnalysis_In - Description of the Parameter

Method Detail

getPhaseShiftKey

public static java.lang.String getPhaseShiftKey()

Returns the key string for graph properties specifying the x-coordinate phase shift.

Returns:

The phase shift key string

setFontsForAll

public void setFontsForAll(java.awt.Font fnt)

Sets fonts for all GUI elements.

Parameters:

fnt - The new fontsForAll value

setMessageTextField

public void setMessageTextField(javax.swing.JTextField messageTextLocal)

Sets local message text field.

Parameters:

messageTextLocal - The new messageTextField value

getMainScanDocument

public java.lang.Object getMainScanDocument()

Returns the main scan document reference as Object instance. It is used to define the resource location.

Returns:

The mainScanDocument value

getDataReaderPanel

public javax.swing.JPanel getDataReaderPanel()

Creates all custom analysis.

Returns:

The dataReaderPanel value

createChildAnalysis

public void createChildAnalysis(DataAdaptor analysisConfig)

Creates all custom analysis.

Parameters:

analysisConfig - Description of the Parameter

dumpChildAnalysisConfig

public void dumpChildAnalysisConfig(DataAdaptor analysisConfig)

Sets the configurations of the analysis by passing config file to the children.

Parameters:

analysisConfig - Description of the Parameter

setScanPVandScanPV_RB_State

public void setScanPVandScanPV_RB_State(boolean scanPV_ShowState,
                                        boolean scanPV_RB_ShowState)

Sets mask specifying if the data for scan PV scan read back PV should be shown.

Parameters:

scanPV_ShowState - The new scanPVandScanPV_RB_State value

scanPV_RB_ShowState - The new scanPVandScanPV_RB_State value

updateDataSetOnGraphPanel

public void updateDataSetOnGraphPanel()

Updates data on the analysis graph panel. This method should be called outside of the analysis controller.

isGoingShowUp

public void isGoingShowUp()

This method executed when analysis panel showing up.

isGoingShutUp

public void isGoingShutUp()

This method executed when analysis panel is about to be shut up.

getPhaseShift

public static double getPhaseShift(java.util.Vector<BasicGraphData> gdV)

Returns the average phase shift value for graphs

Parameters:

gdV - The vector with graph data objects

Returns:

The phase shift value

getPhaseShift

public static double getPhaseShift(BasicGraphData gd)

Returns the phase shift value for graph

Parameters:

gd - The graph data objects

Returns:

The phase shift value

getChoosenDraphData

protected BasicGraphData getChoosenDraphData()

Gets the choosenDraphData attribute of the MainAnalysisController object

Returns:

The choosenDraphData value

getChoosenDraphDataAndPoint

protected java.lang.Object[] getChoosenDraphDataAndPoint()

Gets the choosenDraphDataAndPoint attribute of the MainAnalysisController object

Returns:

The choosenDraphDataAndPoint value