Package dataPlotsFX.data.generic

Class GenericDataPlotInfo

java.lang.Object

dataPlotsFX.data.TDDataInfoFX

dataPlotsFX.data.generic.GenericDataPlotInfo

Direct Known Subclasses:

CPODPlotInfoFX, IshmaelDetPlotInfo, MarkDataPlotInfo, RavenDataPlotInfo, RawClipDataInfo, RWEDataPlotinfoFX

public class GenericDataPlotInfo
extends TDDataInfoFX

Generic data plot info which can work for a wide variety of data types. May still need some data unit specific sub classing, but will hopefully reduce the need for quite so much data specific development.

Author:

Doug Gillespie

Nested Class Summary

Nested classes/interfaces inherited from class dataPlotsFX.data.TDDataInfoFX

TDDataInfoFX.DataLoadObserver

Field Summary

Fields

Modifier and Type	Field	Description
static final double	DEFAULT_FILL_OPACITY

Fields inherited from class dataPlotsFX.data.TDDataInfoFX

dataPlugIns, scaleInfoIndex

Constructor Summary

Constructors

Constructor	Description
GenericDataPlotInfo(TDDataProviderFX tdDataProvider, TDGraphFX tdGraph, PamDataBlock pamDataBlock)

Method Summary

Modifier and Type	Method	Description
TDSymbolChooserFX	createSymbolChooser()
javafx.scene.shape.Polygon	drawDataUnit(int plotNumber, PamDataUnit pamDataUnit, javafx.scene.canvas.GraphicsContext g, double scrollStart, TDProjectorFX tdProjector, int type)	Draw a data unit.
javafx.scene.shape.Polygon	drawFrequencyData(int plotNumber, PamDataUnit pamDataUnit, javafx.scene.canvas.GraphicsContext g, double scrollStart, TDProjectorFX tdProjector, int type)	Base class draws a simple frequency box.
GenericScaleInfo	getAmplitudeScaleInfo()	Get the amplitude scale info.
Double	getAmplitudeValue(PamDataUnit pamDataUnit)
GenericScaleInfo	getBearingScaleInfo()	Get the frequency scale info.
Double	getBearingValue(PamDataUnit pamDataUnit)
Double	getDataValue(PamDataUnit pamDataUnit)	Gets a value for a specific data unit which should be in the same units as the scale information.
GenericScaleInfo	getFrequencyScaleInfo()	Get the frequency scale info.
TDSettingsPane	getGraphSettingsPane()	Return a hiding settings node which will get incorporated into a larger tabbed sliding pane.
ArrayList<TDScaleInfo>	getScaleInfos()	Get all TDScaleInfos for the TDDataInfo.
GenericScaleInfo	getSlantScaleInfo()	Get the frequency scale info.
Double	getSlantValue(PamDataUnit pamDataUnit)
TDSymbolChooserFX	getSymbolChooser()
boolean	setCurrentAxisName(GeneralProjector.ParameterType dataType, GeneralProjector.ParameterUnits dataUnits)	Called when the user selects a specific data line

Methods inherited from class dataPlotsFX.data.TDDataInfoFX

addScaleInfo, clearDraw, drawAllDataUnits, drawData, drawHighLightData, editOptions, getCurrentScaleInfo, getDataBlock, getDataDimensions, getDataName, getDataObserver, getDataProvider, getDDataProvider, getDisplayColType, getLastDrawPoints, getMasterClockOverride, getMenuNodes, getPreviousDataUnit, getRequiredDataHistory, getScaleInfo, getScaleInfo, getScaleInfoIndex, getShortName, getSourceDataBlock, getStoredSettings, getTDGraph, getToolTipText, hasAxisName, hasOptions, isPaused, isScrollChanging, isShowing, isViewer, lastUnitDrawn, notifyChange, removeData, removeScaleInfo, selectScaleInfo, setNPlotPanes, setShowing, setStoredSettings, shouldDraw, shouldDraw, timeRangeSpinnerChange, timeScrollRangeChanged, timeScrollValueChanged

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_FILL_OPACITY

public static final double DEFAULT_FILL_OPACITY

See Also:

• Constant Field Values

Constructor Details

GenericDataPlotInfo

public GenericDataPlotInfo(TDDataProviderFX tdDataProvider,
 TDGraphFX tdGraph,
 PamDataBlock pamDataBlock)

Method Details

drawDataUnit

public javafx.scene.shape.Polygon drawDataUnit(int plotNumber,
 PamDataUnit pamDataUnit,
 javafx.scene.canvas.GraphicsContext g,
 double scrollStart,
 TDProjectorFX tdProjector,
 int type)

Description copied from class: TDDataInfoFX

Draw a data unit.

Overrides:

drawDataUnit in class TDDataInfoFX

Parameters:

pamDataUnit - data unit to draw

g - graphicsContext handle to draw on

type - flag for which type of symbol to draw. e.g normal or highlighted.

Returns:

polygon of area drawn on.

drawFrequencyData

public javafx.scene.shape.Polygon drawFrequencyData(int plotNumber,
 PamDataUnit pamDataUnit,
 javafx.scene.canvas.GraphicsContext g,
 double scrollStart,
 TDProjectorFX tdProjector,
 int type)

Base class draws a simple frequency box. Easily overridden to draw something else, e.g. a contour.

Parameters:

plotNumber -

pamDataUnit -

g -

scrollStart -

tdProjector -

type -

Returns:

getGraphSettingsPane

public TDSettingsPane getGraphSettingsPane()

Description copied from class: TDDataInfoFX

Return a hiding settings node which will get incorporated into a larger tabbed sliding pane.

Overrides:

getGraphSettingsPane in class TDDataInfoFX

Returns:

sliding dialog component.

getDataValue

public Double getDataValue(PamDataUnit pamDataUnit)

Description copied from class: TDDataInfoFX

Gets a value for a specific data unit which should be in the same units as the scale information. This will then be converted into a plot position by the TDGraph.

Specified by:

getDataValue in class TDDataInfoFX

Returns:

data value or null if this data point should not be plotted.

getBearingValue

public Double getBearingValue(PamDataUnit pamDataUnit)

getSlantValue

public Double getSlantValue(PamDataUnit pamDataUnit)

getAmplitudeValue

public Double getAmplitudeValue(PamDataUnit pamDataUnit)

getSymbolChooser

public TDSymbolChooserFX getSymbolChooser()

Specified by:

getSymbolChooser in class TDDataInfoFX

Returns:

a class containing functions to chose a symbol to plot.

createSymbolChooser

public TDSymbolChooserFX createSymbolChooser()

getScaleInfos

public ArrayList<TDScaleInfo> getScaleInfos()

Description copied from class: TDDataInfoFX

Get all TDScaleInfos for the TDDataInfo.

Overrides:

getScaleInfos in class TDDataInfoFX

Returns:

a list of TDScaleInfos.

getAmplitudeScaleInfo

public GenericScaleInfo getAmplitudeScaleInfo()

Get the amplitude scale info.

Returns:

the amplitude scale info.

getFrequencyScaleInfo

public GenericScaleInfo getFrequencyScaleInfo()

Get the frequency scale info.

Returns:

the frequency scale info.

getBearingScaleInfo

public GenericScaleInfo getBearingScaleInfo()

Get the frequency scale info.

Returns:

the frequency scale info.

getSlantScaleInfo

public GenericScaleInfo getSlantScaleInfo()

Get the frequency scale info.

Returns:

the frequency scale info.

setCurrentAxisName

public boolean setCurrentAxisName(GeneralProjector.ParameterType dataType,
 GeneralProjector.ParameterUnits dataUnits)

Called when the user selects a specific data line

Overrides:

setCurrentAxisName in class TDDataInfoFX

Parameters:

dataLine -