Package dataPlotsFX.data.generic
Class GenericDataPlotInfo
java.lang.Object
dataPlotsFX.data.TDDataInfoFX
dataPlotsFX.data.generic.GenericDataPlotInfo
- Direct Known Subclasses:
 CPODPlotInfoFX,DLGroupDetectionInfoFX,IshmaelDetPlotInfo,MarkDataPlotInfo,RavenDataPlotInfo,RawClipDataInfo,RWEDataPlotinfoFX
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
FieldsModifier and TypeFieldDescriptionstatic final doubleprotected GenericScaleInfoThe frequency infoFields inherited from class dataPlotsFX.data.TDDataInfoFX
dataPlugIns, isOrderring, isViewer, scaleInfoIndex - 
Constructor Summary
ConstructorsConstructorDescriptionGenericDataPlotInfo(TDDataProviderFX tdDataProvider, TDGraphFX tdGraph, PamDataBlock pamDataBlock)  - 
Method Summary
Modifier and TypeMethodDescriptionjavafx.scene.shape.PolygondrawBoxData(int plotNumber, PamDataUnit pamDataUnit, double[] f, javafx.scene.canvas.GraphicsContext g, double scrollStart, TDProjectorFX tdProjector, int type) Draw a data unit as a box.javafx.scene.shape.PolygondrawDataUnit(int plotNumber, PamDataUnit pamDataUnit, javafx.scene.canvas.GraphicsContext g, double scrollStart, TDProjectorFX tdProjector, int type) Draw a data unit.javafx.scene.shape.PolygondrawFrequencyData(int plotNumber, PamDataUnit pamDataUnit, javafx.scene.canvas.GraphicsContext g, double scrollStart, TDProjectorFX tdProjector, int type) Base class draws a simple frequency box.Get the amplitude scale info.getAmplitudeValue(PamDataUnit pamDataUnit) Get the frequency scale info.getBearingValue(PamDataUnit pamDataUnit) getDataValue(PamDataUnit pamDataUnit) Gets a value for a specific data unit which should be in the same units as the scale information.Get the frequency scale info.Return a hiding settings node which will get incorporated into a larger tabbed sliding pane.Get all TDScaleInfos for the TDDataInfo.Get the frequency scale info.getSlantValue(PamDataUnit pamDataUnit) booleansetCurrentAxisName(GeneralProjector.ParameterType dataType, GeneralProjector.ParameterUnits dataUnits) Called when the user selects a specific data lineprotected voidprotected voidGo through all the different scale types and check which ones are available.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, getTdDataProvider, getTDGraph, getToolTipText, hasAxisName, hasOptions, isPaused, isScrollChanging, isShowing, isViewer, lastUnitDrawn, notifyChange, removeData, removeScaleInfo, selectScaleInfo, setNPlotPanes, setShowing, setStoredSettings, shouldDraw, shouldDraw, timeRangeSpinnerChange, timeScrollRangeChanged, timeScrollValueChanged 
- 
Field Details
- 
DEFAULT_FILL_OPACITY
public static final double DEFAULT_FILL_OPACITY- See Also:
 
 - 
frequencyInfo
The frequency info 
 - 
 - 
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:TDDataInfoFXDraw a data unit.- Overrides:
 drawDataUnitin classTDDataInfoFX- Parameters:
 pamDataUnit- data unit to drawg- graphicsContext handle to draw ontype- flag for which type of symbol to draw. e.g normal or highlighted.- Returns:
 - polygon of area drawn on.
 
 - 
drawBoxData
public javafx.scene.shape.Polygon drawBoxData(int plotNumber, PamDataUnit pamDataUnit, double[] f, javafx.scene.canvas.GraphicsContext g, double scrollStart, TDProjectorFX tdProjector, int type) Draw a data unit as a box.- Parameters:
 plotNumber- - the pot numberpamDataUnit- - the data unit that will be plottedf- - the y axis max and min valuesg- - the graphics context.scrollStart- - the scroll start in millis.tdProjector- - the graph projector.type- - the plot type.- Returns:
 - a polygon of the data unit.
 
 - 
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
Description copied from class:TDDataInfoFXReturn a hiding settings node which will get incorporated into a larger tabbed sliding pane.- Overrides:
 getGraphSettingsPanein classTDDataInfoFX- Returns:
 - sliding dialog component.
 
 - 
getDataValue
Description copied from class:TDDataInfoFXGets 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:
 getDataValuein classTDDataInfoFX- Parameters:
 pamDataUnit-- Returns:
 - data value or null if this data point should not be plotted.
 
 - 
getBearingValue
 - 
getSlantValue
 - 
getAmplitudeValue
 - 
getSymbolChooser
- Specified by:
 getSymbolChooserin classTDDataInfoFX- Returns:
 - a class containing functions to chose a symbol to plot.
 
 - 
createSymbolChooser
 - 
getScaleInfos
Description copied from class:TDDataInfoFXGet all TDScaleInfos for the TDDataInfo.- Overrides:
 getScaleInfosin classTDDataInfoFX- Returns:
 - a list of TDScaleInfos.
 
 - 
updateAvailability
protected void updateAvailability()Go through all the different scale types and check which ones are available. (only need to do this for ones associated with localisation data since that's the think likely to change dynamically ?). May have to also do some which may be associated with other annotations ? - 
getAmplitudeScaleInfo
Get the amplitude scale info.- Returns:
 - the amplitude scale info.
 
 - 
getFrequencyScaleInfo
Get the frequency scale info.- Returns:
 - the frequency scale info.
 
 - 
getBearingScaleInfo
Get the frequency scale info.- Returns:
 - the frequency scale info.
 
 - 
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:
 setCurrentAxisNamein classTDDataInfoFX- Parameters:
 dataLine-
 - 
setDefaultOpacity
 
 -