Package com.amalgamasimulation.visualsets

Class GanttPiecewisePolylineVisualSet

java.lang.Object

com.amalgamasimulation.visualsets.VisualSet<Pair<Double,Double>>

com.amalgamasimulation.visualsets.AbstractLineVisualSet<Pair<Double,Double>>

com.amalgamasimulation.visualsets.AbstractPolylineVisualSet<Pair<Double,Double>>

com.amalgamasimulation.visualsets.GanttPolylineVisualSet<Pair<Double,Double>>

com.amalgamasimulation.visualsets.GanttPiecewisePolylineVisualSet

All Implemented Interfaces:

IClipboardTextPropertyOwner<Double>, IGanttChartRowPropertyOwner, ILegendNodePropertiesOwner, IMinMaxValuePropertyOwner, IPiecewiseVisualSet, IUpdatePolicyPropertyOwner, IAbstractChartVisualSet, IGanttChartVisualSet

public class GanttPiecewisePolylineVisualSet
extends GanttPolylineVisualSet<Pair<Double,Double>>
implements IPiecewiseVisualSet

Visual set for drawing polylines based on PiecewiseFunction.

Polylines are drawn within a single GanttChartRow that does not have its own numerical vertical axis.

A drawn polyline is usually used not for the purpose of represents exact values, but for the purpose of understanding the general profile of changing values.

The minimum Y-value within the data elements corresponds to the lower bound of the GanttChartRow, and the maximum value corresponds to the upper one. The remaining values are drawn relative to the minimum and maximum.

Uses a discretization method to reduce the amount of data displayed on the chart to improve drawing performance.

The current arguments range displayed on the chart is always used to determine the sampling factor.

Only UpdatePolicy.DYNAMIC is supported.

Author:

Aleksey Kirillov

Nested Class Summary

Nested classes/interfaces inherited from class com.amalgamasimulation.visualsets.GanttPolylineVisualSet

GanttPolylineVisualSet.GanttPolylineVisualElement

Nested classes/interfaces inherited from class com.amalgamasimulation.visualsets.AbstractPolylineVisualSet

AbstractPolylineVisualSet.AbstractPolylineVisualElement

Nested classes/interfaces inherited from class com.amalgamasimulation.visualsets.AbstractLineVisualSet

AbstractLineVisualSet.AbstractLineVisualElement, AbstractLineVisualSet.Extrapolation, AbstractLineVisualSet.PointsAndLinesStyle

Nested classes/interfaces inherited from class com.amalgamasimulation.visualsets.VisualSet

VisualSet.ContextMenuHandler<T>, VisualSet.UpdatePolicy, VisualSet.VisualElement

Field Summary

Fields

Modifier and Type	Field	Description
protected Supplier<Double>	axisLengthInPixelsExtractor
protected Supplier<Double>	currentArgumentExtractor
protected Supplier<Boolean>	discretizeIfNecessaryExtractor
protected Supplier<Pair<Double,Double>>	displayedRangeExtractor
protected Supplier<Integer>	minPixelsPerPlotPointExtractor
protected Supplier<PiecewiseFunction>	piecewiseFunctionExtractor
protected PiecewiseFunction.InterpolationType	piecewiseFunctionInterpolationType
protected PiecewiseVisualSetRangePolicy	piecewiseVisualSetRangePolicy

Fields inherited from class com.amalgamasimulation.visualsets.AbstractPolylineVisualSet

clipboardTextExtractor

Fields inherited from class com.amalgamasimulation.visualsets.AbstractLineVisualSet

extrapolation, legendTextProvider, lineColor, lineStyle, lineWidth, maxValueProvider, pointsAndLinesStyle, pointSize, valueExtractor

Fields inherited from class com.amalgamasimulation.visualsets.VisualSet

argumentExtractor, contentsToBeginArguments, contentsToEndArguments, contentsToVisualElements, contextMenuHandlers, dataElementsProvider, listeners, maxArgument, maxValueCache, minArgument, minValueCache, mouseEnterHandlers, mouseExitHandlers, mousePressedHandlers, mouseTransparent, name, needsUpdate, oldContentsList, tooltipTextExtractor, updatePolicy, visibilityChangeHandlers, visualElementsList

Constructor Summary

Constructors

Constructor	Description
GanttPiecewisePolylineVisualSet(String name, GanttChartRow ganttChartRow, Supplier<PiecewiseFunction> piecewiseFunctionExtractor, Supplier<Pair<Double,Double>> displayedRangeExtractor, Supplier<Double> axisLengthInPixelsExtractor)	Constructs a GanttPiecewiseLineVisualSet with given name, piecewiseFunction extractor and discretization rule extractors.
GanttPiecewisePolylineVisualSet(String name, Supplier<PiecewiseFunction> piecewiseFunctionExtractor, Supplier<Pair<Double,Double>> displayedRangeExtractor, Supplier<Double> axisLengthInPixelsExtractor)	Constructs a GanttPiecewiseLineVisualSet with given name, piecewiseFunction extractor and discretization rule extractors.

Method Summary

Modifier and Type	Method	Description
double	getAxisLengthInPixels()	Returns an actual plot X-axis length in pixels.
double	getCurrentArgument()	Returns a current argument shown on plot.
Pair<Double,Double>	getDisplayedRange()	Returns a current displayed range on plot.
int	getMinPixelsPerPlotPoint()	Returns the minimum pixels per plot point for discretization.
PiecewiseFunction	getPiecewiseFunction()	Returns data elements list provider.
PiecewiseFunction.InterpolationType	getPiecewiseFunctionInterpolationType()	Returns the InterpolationType e.g.
PiecewiseVisualSetRangePolicy	getPiecewiseVisualSetRangePolicy()	Returns the PiecewiseVisualSetRangePolicy for discretization.
VisualSet.UpdatePolicy	getUpdatePolicy()	Return the current VisualSet.UpdatePolicy.
boolean	isDiscretizeIfNecessary()	Returns the necessity rule for discretization.
GanttPiecewisePolylineVisualSet	setAxisLengthInPixelsExtractor(Supplier<Double> axisLengthInPixelsExtractor)	Sets a function that specifies the rule for extracting an actual plot X-axis length in pixels.
GanttPiecewisePolylineVisualSet	setCurrentArgumentExtractor(Supplier<Double> currentArgumentExtractor)	Sets a function that specifies the rule for extracting a current argument shown on plot.
GanttPiecewisePolylineVisualSet	setDiscretizeIfNecessaryExtractor(Supplier<Boolean> discretizeIfNecessaryExtractor)	Sets a function that specifies the necessity rule for discretization.
GanttPiecewisePolylineVisualSet	setDisplayedRangeExtractor(Supplier<Pair<Double,Double>> displayedRangeExtractor)	Sets a function that specifies the rule for extracting a current displayed range on plot.
void	setMaxArgument(double maxArgument)
void	setMinArgument(double minArgument)
GanttPiecewisePolylineVisualSet	setMinPixelsPerPlotPointExtractor(Supplier<Integer> minPixelsPerPlotPointExtractor)	Sets a function that specifies the minimum pixels per plot point for discretization.
GanttPiecewisePolylineVisualSet	setPiecewiseFunctionExtractor(Supplier<PiecewiseFunction> piecewiseFunctionExtractor)	Sets data elements list provider.
GanttPiecewisePolylineVisualSet	setPiecewiseFunctionInterpolationType(PiecewiseFunction.InterpolationType piecewiseFunctionInterpolationType)	Sets the InterpolationType e.g.
GanttPiecewisePolylineVisualSet	setPiecewiseVisualSetRangePolicy(PiecewiseVisualSetRangePolicy piecewiseVisualSetRangePolicy)	Sets an PiecewiseVisualSetRangePolicy for the IPiecewiseVisualSet displayed on the chart.
GanttPiecewisePolylineVisualSet	setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)	Sets the new VisualSet.UpdatePolicy i.e.
protected void	updateMinMaxArguments()

Methods inherited from class com.amalgamasimulation.visualsets.GanttPolylineVisualSet

addContextMenuHandler, addMouseEnterHandler, addMouseExitHandler, addMousePressedHandler, addVisibilityChangeHandler, createVisualElement, getGanttChartRow, getInjectionIndex, getRowHeightFraction, getVisualElements, setClipboardText, setExtrapolation, setLegendText, setLineColor, setLineStyle, setLineWidth, setMaxValue, setMouseTransparent, setPointsAndLinesStyle, setPointSize, setRowHeightFraction, setTooltipText

Methods inherited from class com.amalgamasimulation.visualsets.AbstractPolylineVisualSet

getClipboardText, getValue

Methods inherited from class com.amalgamasimulation.visualsets.AbstractLineVisualSet

getExtrapolation, getLegendColor, getLegendText, getLineColor, getLineStyle, getLineWidth, getMaxValue, getMinValue, getPointsAndLinesStyle, getPointSize, getValue

Methods inherited from class com.amalgamasimulation.visualsets.VisualSet

addVisualElement, addVisualElement, addVisualSetChangeHandler, clearDependencies, getArgument, getContents, getContextMenuHandlers, getDataElements, getMaxArgument, getMinArgument, getMouseEnterHandlers, getMouseExitHandlers, getMousePressedHandlers, getName, getTooltipText, getVisibilityChangeHandlers, getVisibleVisualElementIndex, getVisibleVisualElementsCount, isMouseTransparent, isNeedsUpdate, recalculateVisualElements, removeContextMenuHandler, removeMouseEnterHandler, removeMouseExitHandler, removeMousePressedHandler, removeVisibilityChangeHandler, removeVisualElement, removeVisualSetChangeHandler, sortVisualElements, toString, update, updateMinMaxArgumentsValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amalgamasimulation.visualsets.types.IAbstractChartVisualSet

addVisualSetChangeHandler, getContents, getMaxArgument, getMinArgument, getName, getVisibilityChangeHandlers, getVisibleVisualElementsCount, isMouseTransparent, removeVisibilityChangeHandler, removeVisualSetChangeHandler

Methods inherited from interface com.amalgamasimulation.visualsets.IPiecewiseVisualSet

getDiscretizationFactor, getDiscretizedDataElements, getMaxArgument, invalidatePiecewiseMinMaxArguments

Field Details

piecewiseVisualSetRangePolicy

protected PiecewiseVisualSetRangePolicy piecewiseVisualSetRangePolicy

piecewiseFunctionInterpolationType

protected PiecewiseFunction.InterpolationType piecewiseFunctionInterpolationType

piecewiseFunctionExtractor

protected Supplier<PiecewiseFunction> piecewiseFunctionExtractor

displayedRangeExtractor

protected Supplier<Pair<Double,Double>> displayedRangeExtractor

axisLengthInPixelsExtractor

protected Supplier<Double> axisLengthInPixelsExtractor

discretizeIfNecessaryExtractor

protected Supplier<Boolean> discretizeIfNecessaryExtractor

minPixelsPerPlotPointExtractor

protected Supplier<Integer> minPixelsPerPlotPointExtractor

currentArgumentExtractor

protected Supplier<Double> currentArgumentExtractor

Constructor Details

GanttPiecewisePolylineVisualSet

public GanttPiecewisePolylineVisualSet(String name,
 Supplier<PiecewiseFunction> piecewiseFunctionExtractor,
 Supplier<Pair<Double,Double>> displayedRangeExtractor,
 Supplier<Double> axisLengthInPixelsExtractor)

Constructs a GanttPiecewiseLineVisualSet with given name, piecewiseFunction extractor and discretization rule extractors.

Parameters:

name - visual set name is used to sort and name the visual sets on the chart

piecewiseFunctionExtractor - data elements list provider. The provider is invalidated every time the chart is being redrawn

displayedRangeExtractor - a function that specifies the rule for extracting a current displayed range on plot

axisLengthInPixelsExtractor - a function that specifies the rule for extracting an actual plot X-axis length in pixels

GanttPiecewisePolylineVisualSet

public GanttPiecewisePolylineVisualSet(String name,
 GanttChartRow ganttChartRow,
 Supplier<PiecewiseFunction> piecewiseFunctionExtractor,
 Supplier<Pair<Double,Double>> displayedRangeExtractor,
 Supplier<Double> axisLengthInPixelsExtractor)

Constructs a GanttPiecewiseLineVisualSet with given name, piecewiseFunction extractor and discretization rule extractors.

Parameters:

name - visual set name is used to sort and name the visual sets on the chart

ganttChartRow - GanttChartRow which displays this visual set i.e. the Y-axis value

piecewiseFunctionExtractor - data elements list provider. The provider is invalidated every time the chart is being redrawn

displayedRangeExtractor - a function that specifies the rule for extracting a current displayed range on plot

axisLengthInPixelsExtractor - a function that specifies the rule for extracting an actual plot X-axis length in pixels

Method Details

setPiecewiseFunctionExtractor

public GanttPiecewisePolylineVisualSet setPiecewiseFunctionExtractor(Supplier<PiecewiseFunction> piecewiseFunctionExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets data elements list provider. The provider is invalidated every time the chart is being redrawn.

Specified by:

setPiecewiseFunctionExtractor in interface IPiecewiseVisualSet

Parameters:

piecewiseFunctionExtractor - data elements list provider

Returns:

reference to this object

setPiecewiseVisualSetRangePolicy

public GanttPiecewisePolylineVisualSet setPiecewiseVisualSetRangePolicy(PiecewiseVisualSetRangePolicy piecewiseVisualSetRangePolicy)

Description copied from interface: IPiecewiseVisualSet

Sets an PiecewiseVisualSetRangePolicy for the IPiecewiseVisualSet displayed on the chart.

Specified by:

setPiecewiseVisualSetRangePolicy in interface IPiecewiseVisualSet

Parameters:

piecewiseVisualSetRangePolicy - an PiecewiseVisualSetRangePolicy for the IPiecewiseVisualSet displayed on the chart.

Returns:

reference to this object

setDiscretizeIfNecessaryExtractor

public GanttPiecewisePolylineVisualSet setDiscretizeIfNecessaryExtractor(Supplier<Boolean> discretizeIfNecessaryExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the necessity rule for discretization.

Specified by:

setDiscretizeIfNecessaryExtractor in interface IPiecewiseVisualSet

Parameters:

discretizeIfNecessaryExtractor - a function that specifies the necessity rule for discretization

Returns:

reference to this object

setMinPixelsPerPlotPointExtractor

public GanttPiecewisePolylineVisualSet setMinPixelsPerPlotPointExtractor(Supplier<Integer> minPixelsPerPlotPointExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the minimum pixels per plot point for discretization.

Specified by:

setMinPixelsPerPlotPointExtractor in interface IPiecewiseVisualSet

Parameters:

minPixelsPerPlotPointExtractor - a function that specifies the minimum pixels per plot point for discretization

Returns:

reference to this object

setDisplayedRangeExtractor

public GanttPiecewisePolylineVisualSet setDisplayedRangeExtractor(Supplier<Pair<Double,Double>> displayedRangeExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the rule for extracting a current displayed range on plot.

Specified by:

setDisplayedRangeExtractor in interface IPiecewiseVisualSet

Parameters:

displayedRangeExtractor - a function that specifies the rule for extracting a current displayed range on plot

Returns:

reference to this object

setAxisLengthInPixelsExtractor

public GanttPiecewisePolylineVisualSet setAxisLengthInPixelsExtractor(Supplier<Double> axisLengthInPixelsExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the rule for extracting an actual plot X-axis length in pixels.

Specified by:

setAxisLengthInPixelsExtractor in interface IPiecewiseVisualSet

Parameters:

axisLengthInPixelsExtractor - a function that specifies the rule for extracting an actual plot X-axis length in pixels

Returns:

reference to this object

setPiecewiseFunctionInterpolationType

public GanttPiecewisePolylineVisualSet setPiecewiseFunctionInterpolationType(PiecewiseFunction.InterpolationType piecewiseFunctionInterpolationType)

Description copied from interface: IPiecewiseVisualSet

Sets the InterpolationType e.g. the interpolation method between PiecewiseFunction grid points. InterpolationType.PEAK used by default.

Specified by:

setPiecewiseFunctionInterpolationType in interface IPiecewiseVisualSet

Parameters:

piecewiseFunctionInterpolationType - the interpolation method between PiecewiseFunction grid points.

Returns:

reference to this object

setCurrentArgumentExtractor

public GanttPiecewisePolylineVisualSet setCurrentArgumentExtractor(Supplier<Double> currentArgumentExtractor)

Description copied from interface: IPiecewiseVisualSet

Sets a function that specifies the rule for extracting a current argument shown on plot.

Specified by:

setCurrentArgumentExtractor in interface IPiecewiseVisualSet

Parameters:

currentArgumentExtractor - a function that specifies the rule for extracting a current argument shown on plot

Returns:

reference to this object

getCurrentArgument

public double getCurrentArgument()

Description copied from interface: IPiecewiseVisualSet

Returns a current argument shown on plot.

Specified by:

getCurrentArgument in interface IPiecewiseVisualSet

Returns:

a current argument shown on plot

getPiecewiseFunction

public PiecewiseFunction getPiecewiseFunction()

Description copied from interface: IPiecewiseVisualSet

Returns data elements list provider.

Specified by:

getPiecewiseFunction in interface IPiecewiseVisualSet

Returns:

data elements list provider.

getPiecewiseVisualSetRangePolicy

public PiecewiseVisualSetRangePolicy getPiecewiseVisualSetRangePolicy()

Description copied from interface: IPiecewiseVisualSet

Returns the PiecewiseVisualSetRangePolicy for discretization.

Specified by:

getPiecewiseVisualSetRangePolicy in interface IPiecewiseVisualSet

Returns:

the PiecewiseVisualSetRangePolicy for discretization

isDiscretizeIfNecessary

public boolean isDiscretizeIfNecessary()

Description copied from interface: IPiecewiseVisualSet

Returns the necessity rule for discretization.

Specified by:

isDiscretizeIfNecessary in interface IPiecewiseVisualSet

Returns:

the necessity rule for discretization

getMinPixelsPerPlotPoint

public int getMinPixelsPerPlotPoint()

Description copied from interface: IPiecewiseVisualSet

Returns the minimum pixels per plot point for discretization.

Specified by:

getMinPixelsPerPlotPoint in interface IPiecewiseVisualSet

Returns:

the minimum pixels per plot point for discretization

getDisplayedRange

public Pair<Double,Double> getDisplayedRange()

Description copied from interface: IPiecewiseVisualSet

Returns a current displayed range on plot.

Specified by:

getDisplayedRange in interface IPiecewiseVisualSet

Returns:

a current displayed range on plot

getAxisLengthInPixels

public double getAxisLengthInPixels()

Description copied from interface: IPiecewiseVisualSet

Returns an actual plot X-axis length in pixels.

Specified by:

getAxisLengthInPixels in interface IPiecewiseVisualSet

Returns:

an actual plot X-axis length in pixels

getPiecewiseFunctionInterpolationType

public PiecewiseFunction.InterpolationType getPiecewiseFunctionInterpolationType()

Description copied from interface: IPiecewiseVisualSet

Returns the InterpolationType e.g. the interpolation method between PiecewiseFunction grid points.

Specified by:

getPiecewiseFunctionInterpolationType in interface IPiecewiseVisualSet

Returns:

the InterpolationType e.g. the interpolation method between PiecewiseFunction grid points.

updateMinMaxArguments

protected void updateMinMaxArguments()

Overrides:

updateMinMaxArguments in class VisualSet<Pair<Double,Double>>

setMinArgument

public void setMinArgument(double minArgument)

Specified by:

setMinArgument in interface IPiecewiseVisualSet

setMaxArgument

public void setMaxArgument(double maxArgument)

Specified by:

setMaxArgument in interface IPiecewiseVisualSet

setUpdatePolicy

public GanttPiecewisePolylineVisualSet setUpdatePolicy(VisualSet.UpdatePolicy updatePolicy)

Description copied from interface: IAbstractChartVisualSet

Sets the new VisualSet.UpdatePolicy i.e. the VisualSet update control rule.

Specified by:

setUpdatePolicy in interface IAbstractChartVisualSet

Specified by:

setUpdatePolicy in interface IUpdatePolicyPropertyOwner

Overrides:

setUpdatePolicy in class GanttPolylineVisualSet<Pair<Double,Double>>

Parameters:

updatePolicy - new VisualSet.UpdatePolicy i.e. the VisualSet update control rule

Returns:

reference to this object

getUpdatePolicy

public VisualSet.UpdatePolicy getUpdatePolicy()

Description copied from interface: IAbstractChartVisualSet

Return the current VisualSet.UpdatePolicy.

Specified by:

getUpdatePolicy in interface IAbstractChartVisualSet

Specified by:

getUpdatePolicy in interface IUpdatePolicyPropertyOwner

Overrides:

getUpdatePolicy in class VisualSet<Pair<Double,Double>>

Returns:

the current VisualSet.UpdatePolicy