Package de.gsi.chart.renderer.spi

Class AbstractErrorDataSetRendererParameter<R extends AbstractErrorDataSetRendererParameter<R>>

  • Type Parameters:
    R - generic object type for renderer parameter
    All Implemented Interfaces:
    Renderer
    Direct Known Subclasses:
    ErrorDataSetRenderer
    public abstract class AbstractErrorDataSetRendererParameter<R extends AbstractErrorDataSetRendererParameter<R>>
extends AbstractDataSetManagement<R>
    simple class to move the various parameters out of the class containing the algorithms uses the shadow field pattern to minimise memory usage (lots of boiler-plate code ... sorry)
    Author:
    rstein

    • Field Detail

      • DEFAULT_HISTORY_INTENSITY_FADING

        protected static final double DEFAULT_HISTORY_INTENSITY_FADING
        See Also:
        Constant Field Values

      • algorithmChoice

        protected javafx.beans.property.BooleanProperty algorithmChoice

      • numberOfPoints

        protected javafx.beans.property.IntegerProperty numberOfPoints

    • Constructor Detail

      • AbstractErrorDataSetRendererParameter

        public AbstractErrorDataSetRendererParameter()

    • Method Detail

      • bind

        protected R bind​(R other)

      • unbind

        protected R unbind()

      • setErrorType

        public R setErrorType​(ErrorStyle style)
        sets the error bar/surface plotting style ErrorBarRenderer.ESTYLE_NONE: no errors are drawn ErrorBarRenderer.ESTYLE_BAR: error bars are drawn (default) ErrorBarRenderer.ESTYLE_SURFACE: error surface is drawn
        Parameters:
        style - ErrorStyle @see ErrorStyle enum
        Returns:
        itself (fluent design)

      • getErrorType

        public ErrorStyle getErrorType()
        Returns:
        returns error plotting style
        See Also:
        for details

      • errorStyleProperty

        public javafx.beans.property.ObjectProperty<ErrorStyle> errorStyleProperty()
        sets the error bar/surface plotting style ErrorBarRenderer.ESTYLE_NONE: no errors are drawn ErrorBarRenderer.ESTYLE_BAR: error bars are drawn (default) ErrorBarRenderer.ESTYLE_SURFACE: error surface is drawn
        Returns:
        the errorStyle

      • isReducePoints

        public boolean isReducePoints()
        Sets whether superfluous points, otherwise drawn on the same pixel area, are merged and represented by the multiple point average.
        Returns:
        true if point reduction is on (default) else false.

      • setPointReduction

        public R setPointReduction​(boolean state)
        Sets whether superfluous points, otherwise drawn on the same pixel area, are merged and represented by the multiple point average.
        Parameters:
        state - true if data points are supposed to be reduced
        Returns:
        itself (fluent design)

      • pointReductionProperty

        public javafx.beans.property.BooleanProperty pointReductionProperty()
        Sets whether superfluous points, otherwise drawn on the same pixel area, are merged and represented by the multiple point average.
        Returns:
        true if data points are supposed to be reduced

      • getDashSize

        public int getDashSize()
        Returns the dashSize.
        Returns:
        the dashSize.

      • setDashSize

        public R setDashSize​(int dashSize)
        Sets the dashSize to the specified value. The dash is the horizontal line painted at the ends of the vertical line. It is not painted if set to 0.
        Parameters:
        dashSize - the dashSize to set.
        Returns:
        itself (fluent design)

      • dashSizeProperty

        public javafx.beans.property.IntegerProperty dashSizeProperty()

      • getMinRequiredReductionSize

        public int getMinRequiredReductionSize()
        Returns:
        the minimum number of samples before performing data reduction

      • setMinRequiredReductionSize

        public R setMinRequiredReductionSize​(int size)
        Parameters:
        size - the minimum number of samples before performing data reduction
        Returns:
        itself (fluent design)

      • minRequiredReductionSizeProperty

        public javafx.beans.property.IntegerProperty minRequiredReductionSizeProperty()

      • getMarkerSize

        public double getMarkerSize()
        Returns the markerSize.
        Returns:
        the markerSize.

      • setMarkerSize

        public R setMarkerSize​(double size)
        Sets the markerSize to the specified value.
        Parameters:
        size - the markerSize to set.
        Returns:
        itself (fluent design)

      • markerSizeProperty

        public javafx.beans.property.DoubleProperty markerSizeProperty()

      • getIntensityFading

        public double getIntensityFading()
        Returns the intensityFading.
        Returns:
        the intensityFading.

      • setIntensityFading

        public R setIntensityFading​(double size)
        Sets the intensityFading to the specified value.
        Parameters:
        size - the intensityFading to set.
        Returns:
        itself (fluent design)

      • intensityFadingProperty

        public javafx.beans.property.DoubleProperty intensityFadingProperty()

      • isDrawMarker

        public boolean isDrawMarker()
        Returns:
        true if point reduction is on (default) else false.

      • setDrawMarker

        public R setDrawMarker​(boolean state)
        Parameters:
        state - true -> draws markers
        Returns:
        itself (fluent design)

      • drawMarkerProperty

        public javafx.beans.property.BooleanProperty drawMarkerProperty()
        Returns:
        the drawMarker state

      • isDrawBars

        public boolean isDrawBars()
        Returns:
        true if bars from the data points to the y==0 axis shall be drawn

      • setDrawBars

        public R setDrawBars​(boolean state)
        Parameters:
        state - true if bars from the data points to the y==0 axis shall be drawn
        Returns:
        itself (fluent design)

      • drawBarsProperty

        public javafx.beans.property.BooleanProperty drawBarsProperty()
        Returns:
        the drawBars state

      • isShiftBar

        public boolean isShiftBar()
        Returns:
        true if bars drawn to the y==0 axis shall be horizontally shifted for each DataSet

      • setShiftBar

        public R setShiftBar​(boolean state)
        Parameters:
        state - true if bars drawn to the y==0 axis shall be horizontally shifted for each DataSet
        Returns:
        itself (fluent design)

      • shiftBarProperty

        public javafx.beans.property.BooleanProperty shiftBarProperty()
        Returns:
        the shiftBar state

      • getShiftBarOffset

        public int getShiftBarOffset()
        Returns the shiftBarOffset.
        Returns:
        the shiftBarOffset.

      • setshiftBarOffset

        public R setshiftBarOffset​(int shiftBarOffset)
        Sets the shiftBarOffset to the specified value.
        Parameters:
        shiftBarOffset - the shiftBarOffset to set.
        Returns:
        itself (fluent design)

      • shiftBarOffsetProperty

        public javafx.beans.property.IntegerProperty shiftBarOffsetProperty()

      • isDynamicBarWidth

        public boolean isDynamicBarWidth()
        Returns:
        true whether the width of bars drawn to the '0' shall be dynamically to the shown axis width

      • setDynamicBarWidth

        public R setDynamicBarWidth​(boolean state)
        Parameters:
        state - true whether the width of bars drawn to the '0' shall be dynamically to the shown axis width
        Returns:
        itself (fluent design)

      • dynamicBarWidthProperty

        public javafx.beans.property.BooleanProperty dynamicBarWidthProperty()
        Returns:
        the dynamicBarWidth state

      • getBarWidthPercentage

        public double getBarWidthPercentage()
        Returns:
        the barWidthPercentage of the total X space should be taken to paint // bars.

      • setBarWidthPercentage

        public R setBarWidthPercentage​(double size)
        Parameters:
        size - the barWidthPercentage of the total X space should be taken to paint
        Returns:
        itself (fluent design)

      • barWidthPercentageProperty

        public javafx.beans.property.DoubleProperty barWidthPercentageProperty()

      • getBarWidth

        public int getBarWidth()
        Returns:
        the barWidth in case of constant width bards being drawn @see setDynamicBarWidth()

      • setBarWidth

        public R setBarWidth​(int barWidth)
        Parameters:
        barWidth - the barWidth in case of constant width bards being drawn @see setDynamicBarWidth()
        Returns:
        itself (fluent design)

      • barWidthProperty

        public javafx.beans.property.IntegerProperty barWidthProperty()

      • isParallelImplementation

        public boolean isParallelImplementation()
        whether renderer should aim at parallelising sub-functionalities
        Returns:
        true if renderer is parallelising sub-functionalities

      • setParallelImplementation

        public R setParallelImplementation​(boolean state)
        Sets whether renderer should aim at parallelising sub-functionalities
        Parameters:
        state - true if renderer is parallelising sub-functionalities
        Returns:
        itself (fluent design)

      • parallelImplementationProperty

        public javafx.beans.property.BooleanProperty parallelImplementationProperty()
        Sets whether renderer should aim at parallelising sub-functionalities
        Returns:
        true if data points are supposed to be reduced

      • getPolyLineStyle

        public LineStyle getPolyLineStyle()
        whether renderer should draw no, simple (point-to-point), stair-case, Bezier, ... lines
        Returns:
        LineStyle

      • setPolyLineStyle

        public R setPolyLineStyle​(LineStyle style)
        Sets whether renderer should draw no, simple (point-to-point), stair-case, Bezier, ... lines
        Parameters:
        style - draw no, simple (point-to-point), stair-case, Bezier, ... lines
        Returns:
        itself (fluent design)

      • polyLineStyleProperty

        public javafx.beans.property.ObjectProperty<LineStyle> polyLineStyleProperty()
        Sets whether renderer should draw no, simple (point-to-point), stair-case, Bezier, ... lines
        Returns:
        property

      • getAlgorithmChoice

        public boolean getAlgorithmChoice()

      • setAlgorithmChoice

        public R setAlgorithmChoice​(boolean value)

      • algorithmChoiceProperty

        public javafx.beans.property.BooleanProperty algorithmChoiceProperty()
        Sets whether superfluous points, otherwise drawn on the same pixel area, are merged and represented by the multiple point average.
        Returns:
        algorithm choice

      • getNumberOfPoints

        public int getNumberOfPoints()
        Returns the numberOfPoint.
        Returns:
        the numberOfPoint.

      • setNumberOfPoints

        public R setNumberOfPoints​(int numberOfPoint)
        Sets the numberOfPoint to the specified value.
        Parameters:
        numberOfPoint - the numberOfPoint to set.
        Returns:
        itself (fluent design)

      • numberOfPointsProperty

        public javafx.beans.property.IntegerProperty numberOfPointsProperty()