com.highqsoft.med

Interface MEDCalculatorInterface

All Superinterfaces:

FwkCommandInterface, FwkControlledByInterface, FwkDialogPaneValueInterface, FwkInstructionInterface, FwkInterface, FwkPresentationInterface, FwkPropertyChangeInterface, java.util.Map, java.io.Serializable

All Known Implementing Classes:

MEDCalculator, MEDCut, MEDLevelCut, MEDLinearOffset, MEDScale, MEDSmooth

public interface MEDCalculatorInterface
extends FwkCommandInterface, FwkDialogPaneValueInterface

The MED calculator interface.

Since:

$Date: 2017/04/06 13:29:29 $

Version:

$Revision: 1.11 $

Author:

Andreas Hofmann

See Also:

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

CONTROLLER_PROPERTY, MENU_REASON_CANCELED, MENU_REASON_DESELECTED, MENU_REASON_SELECTED

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	calculate() The highlevelCalculate the results.
double[]	calculate(double[] independent, double[] data) Calculate the results of a single channel.
FwkArrayInterface	calculate(FwkColumnAccessInterface independent, FwkArrayInterface channels, FwkArrayInterface markers) Calculate the results.
boolean	canChangeChannel() Returns a boolean that signals whether or not the calculator is able to change a channel.
boolean	canCopyChannel() Returns a boolean that signals whether or not the calculator is able to create a channel.
boolean	canCreateImplicitChannel() Returns a boolean that signals whether or not the calculator is able to create an implicit channel.
boolean	checkCalulatorPanel() Check the calculator specific dialog panel values.
FwkPanelInterface	getCalculatorPanel() Get the calculator dialog.
java.lang.String	getCalculatorPanelPosition() Get the calculator panel position.
java.lang.String	getChannelColumnName(FwkColumnAccessInterface col, double[] limit) Get the column name of a newly created channel.
boolean	getChannelCopy() Get the channel COPY flag.
boolean	getChannelCut() Get the channel CUT flag.
java.lang.String	getChannelFilter() Get the channel selection filter.
java.lang.String	getChannelInfoBusName() Get the name of the infobus from where the channel should be selected.
java.lang.String	getChannelName(FwkColumnAccessInterface col, double[] limit) Get the name of a newly created channel.
java.lang.String[]	getChannelNames() Returns an array containing all selected channel names.
FwkDialogPaneInterface	getDialogPanel() Get the dialog panel to select channels and markers.
java.awt.Container	getDialogParent(java.util.EventObject ev) Returns the dialog parent, if available.
boolean	getImplicitChannelCalculation() Get the implicit channel calculation flag.
java.lang.String	getIndependentChannelName() Get the name of the independent column.
java.lang.String	getIndependentFilter() Get the independent channel selection filter.
java.lang.String	getMarkerFilter() Get the marker selection filter.
java.lang.String	getMarkerInfoBusName() Get the name of the infobus from where the marker should be selected.
java.lang.String[]	getMarkerNames() Returns an array containing all selected marker names.
MEDInterface	getMED() Returns the MED object belongs to that command if available.
void	init() Init the calculator.
void	release() Release the calculator.
void	setCalculatorPanelPosition(java.lang.String position) Set the calculator panel position.
void	setChannelCopy(boolean flag) Set the channel COPY flag.
void	setChannelCut(boolean flag) Set the channel CUT flag.
void	setChannelFilter(java.lang.String filter) Set the channel filter for dialog.
void	setChannelNames(java.lang.String[] channels) Sets an array containing all selected channel names.
void	setImplicitChannelCalculation(boolean flag) Set the implicit channel calculation flag.
void	setIndependentChannelName(java.lang.String name) Set the name of the independent column.
void	setIndependentFilter(java.lang.String filter) Set the indenpendent channel filter for dialog.
void	setMarkerFilter(java.lang.String filter) Set the marker filter for dialog.
void	setMarkerNames(java.lang.String[] markers) Sets an array containing all selected marker names.

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkCommandInterface

addActionListener, addMenuListener, execute, getActionListenerArray, getButtonClass, getCommandName, getHelpID, getIcon, getIconKey, getMenuEventEnabled, getMenuItemClass, getMenuListenerArray, getMnemonic, getProperties, getProperty, getRadioGroupState, getSensitivity, getSeparator, getText, getTextKey, getToggle, getToggleState, getToolBarEnabled, getToolTipKey, getToolTipText, getVisibility, hasActionListeners, hasMenuListeners, isParent, menuSelect, register, registeredObjects, registrySize, removeActionListener, removeMenuListener, setAsParent, setButtonClass, setCommandName, setHelpID, setIcon, setIconKey, setMenuEventEnabled, setMenuItemClass, setMnemonic, setProperty, setRadioGroupState, setSensitivity, setSeparator, setText, setTextKey, setToggle, setToggleState, setToolBarEnabled, setToolTipKey, setToolTipText, setVisibility, unregister

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInstructionInterface

addCommand, addCommand, addToGroup, addToGroup, clearCommands, commandsAvailable, deleteGroup, getCommand, getCommands, getGroup, groupExists, removeCommand, removeFromGroup, setCommands

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPresentationInterface

getPresentationString, getPresentationString

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

getVersion

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkControlledByInterface

getController, setController

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDialogPaneValueInterface

getIdent, getProperties, getProperty, setIdent, setProperties, setProperty

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkPropertyChangeInterface

addPropertyChangeListener, addPropertyChangeListener, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeArray, getPropertyChangeListenerArray, getPropertyChangeListenerArray, isPropertyChangeEventSuspended, removePropertyChangeListener, removePropertyChangeListener, setSource, suspendPropertyChangeEvents

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

calculate

double[] calculate(double[] independent,
                 double[] data)
                   throws FwkException

Calculate the results of a single channel.

Parameters:

independent - An array containing The independent channel.
This value is optional and may be null.

data - The array containing the channel data of interest.

Returns:

The array of calculated data containing the region of interest.

Throws:

FwkException

calculate

FwkArrayInterface calculate(FwkColumnAccessInterface independent,
                          FwkArrayInterface channels,
                          FwkArrayInterface markers)
                            throws FwkException

Calculate the results.

Parameters:

independent - The independent channel.
This value is optional and may be null. The column access interface has a method to ask for the independent channel. In general the calculation routine is responsable to select the right independent channel.

channels - The array containing the channels. This array may be null or empty.

markers - The array containing the markers. This array may be null or empty.

Returns:

The vector of channels or markers.

Throws:

FwkException

calculate

java.lang.String[] calculate()
                             throws FwkException

The highlevelCalculate the results.

This method handles the infobus communication that is necessary to get the input data and to publish the result data. This method uses the lowe level calculation method for the core calculation.

Returns:

The array of resulting channels or markers.

Throws:

FwkException

See Also:

calculate(FwkArrayInterface, FwkArrayInterface)

getCalculatorPanel

FwkPanelInterface getCalculatorPanel()

Get the calculator dialog.

This method should return a dialog to configurate the calculator specific properties.

Returns:

the calculator dialog pane.

checkCalulatorPanel

boolean checkCalulatorPanel()
                            throws FwkException

Check the calculator specific dialog panel values. This is used to numerical input field and other user input critical dialog elements.

Returns:

true if the check was successfull.

Throws:

FwkException - if the check failed. The calculator is responsable. to signal the problem to the user.

setCalculatorPanelPosition

void setCalculatorPanelPosition(java.lang.String position)

Set the calculator panel position.
possible values are:

• BorderLayout.CENTER
• BorderLayout.NORTH
• BorderLayout.SOUTH
• BorderLayout.EAST
• BorderLayout.WEST

Parameters:

position - The position of the panel.

getCalculatorPanelPosition

java.lang.String getCalculatorPanelPosition()

Get the calculator panel position.

Parameters:

position - The position of the panel.

See Also:

setCalculatorPanelPosition(String)

getDialogPanel

FwkDialogPaneInterface getDialogPanel()

Get the dialog panel to select channels and markers.

getDialogParent

java.awt.Container getDialogParent(java.util.EventObject ev)

Returns the dialog parent, if available.

Returns:

The dialog parent belongs to the event object.

getChannelNames

java.lang.String[] getChannelNames()

Returns an array containing all selected channel names.

Returns:

all selected channel names.

setChannelNames

void setChannelNames(java.lang.String[] channels)

Sets an array containing all selected channel names.

Parameters:

channels - all selected channel names.

setIndependentChannelName

void setIndependentChannelName(java.lang.String name)

Set the name of the independent column.

Parameters:

name - the name of the independent column.

getIndependentChannelName

java.lang.String getIndependentChannelName()

Get the name of the independent column.

Returns:

The name of the independent column.

getChannelInfoBusName

java.lang.String getChannelInfoBusName()

Get the name of the infobus from where the channel should be selected.

Returns:

the infobus name where the channel are available.

getMarkerNames

java.lang.String[] getMarkerNames()

Returns an array containing all selected marker names.

Returns:

all selected marker names.

setMarkerNames

void setMarkerNames(java.lang.String[] markers)

Sets an array containing all selected marker names.

Parameters:

markers - all selected marker names.

getMarkerInfoBusName

java.lang.String getMarkerInfoBusName()

Get the name of the infobus from where the marker should be selected.

Returns:

the infobus name where the marker are available.

setChannelCopy

void setChannelCopy(boolean flag)

Set the channel COPY flag.

Parameters:

flag - if true the source channels will be copied.

getChannelCopy

boolean getChannelCopy()

Get the channel COPY flag.

Returns:

true if the source channels will be copied.

setChannelCut

void setChannelCut(boolean flag)

Set the channel CUT flag.

Parameters:

flag - if true the source area of interest will be cut out of the source channel.

getChannelCut

boolean getChannelCut()

Get the channel CUT flag.

Returns:

if true the source area of interest will be cut out of the source channel.

setImplicitChannelCalculation

void setImplicitChannelCalculation(boolean flag)

Set the implicit channel calculation flag.

Parameters:

flag - if true the source channels will be calculated implicitly. This means that the data will be calculated at every request.

See Also:

setImplictChannelCalculation()

getImplicitChannelCalculation

boolean getImplicitChannelCalculation()

Get the implicit channel calculation flag.

Returns:

true if the source channels will be calculated implicitly.

See Also:

setImplictChannelCalculation(boolean)

getChannelName

java.lang.String getChannelName(FwkColumnAccessInterface col,
                              double[] limit)

Get the name of a newly created channel.

Parameters:

col - the source channel.

limit - a two element array containing the upper and the lower limit.

getChannelColumnName

java.lang.String getChannelColumnName(FwkColumnAccessInterface col,
                                    double[] limit)

Get the column name of a newly created channel.

Parameters:

col - the source channel.

limit - a two element array containing the upper and the lower limit.

getMarkerFilter

java.lang.String getMarkerFilter()

Get the marker selection filter.

Returns:

the filter for the marker dialog selection.

setMarkerFilter

void setMarkerFilter(java.lang.String filter)

Set the marker filter for dialog.

Parameters:

filter - the marker dialog filter.

getChannelFilter

java.lang.String getChannelFilter()

Get the channel selection filter.

Returns:

the filter for the channel dialog selection.

setChannelFilter

void setChannelFilter(java.lang.String filter)

Set the channel filter for dialog.

Parameters:

filter - the channel dialog filter.

getIndependentFilter

java.lang.String getIndependentFilter()

Get the independent channel selection filter.

Returns:

the filter for the independent channel dialog selection.

setIndependentFilter

void setIndependentFilter(java.lang.String filter)

Set the indenpendent channel filter for dialog.

Parameters:

filter - the independent channel dialog filter.

init

void init()

Init the calculator. This method is called before something is done by execute method.

See Also:

FwkCommandInterface.execute(EventObject)

release

void release()

Release the calculator. This method is called after all things are done by the execute method.

Specified by:

release in interface FwkInterface

See Also:

FwkCommandInterface.execute(EventObject)

getMED

MEDInterface getMED()

Returns the MED object belongs to that command if available.

Returns:

The dialog parent belongs to the event object.

canCreateImplicitChannel

boolean canCreateImplicitChannel()

Returns a boolean that signals whether or not the calculator is able to create an implicit channel.

Returns:

true if the calculator is able to create an implicit channel.

canChangeChannel

boolean canChangeChannel()

Returns a boolean that signals whether or not the calculator is able to change a channel.

Returns:

true if the calculator is able to change a channel.

canCopyChannel

boolean canCopyChannel()

Returns a boolean that signals whether or not the calculator is able to create a channel.

Returns:

true if the calculator is able to create a channel.