org.opentrafficsim.graphs

Class Axis

java.lang.Object

org.opentrafficsim.graphs.Axis

All Implemented Interfaces:

Serializable

public class Axis
extends Object
implements Serializable

Definition of one axis for a ContourPlot.

Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-08-30 00:16:51 +0200 (Sun, 30 Aug 2015) $, @version $Revision: 1329 $, by $Author: averbraeck $, initial version Jul 28, 2014

Author:

Peter Knoppers

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Axis(org.djunits.value.vdouble.scalar.DoubleScalarInterface minimumValue, org.djunits.value.vdouble.scalar.DoubleScalarInterface maximumValue, double[] granularities, double initialGranularity, String name, String shortName, String format) Create a new AxisDefinition.

Method Summary

Modifier and Type	Method and Description
void	adjustMaximumValue(org.djunits.value.vdouble.scalar.DoubleScalarInterface newMaximum) Adjust (increase) the range of this AxisDefinition.
int	getAggregatedBinCount()
int	getBinCount()
double	getCurrentGranularity() Get the granularity of this axis.
String	getFormat() Retrieve the format for displaying values along this Axis.
double[]	getGranularities() Retrieve the possible granularities for this Axis.
org.djunits.value.vdouble.scalar.DoubleScalarInterface	getMaximumValue() Get the maximum value of this axis.
org.djunits.value.vdouble.scalar.DoubleScalarInterface	getMinimumValue() Get the minimum value of this axis.
String	getName() Retrieve the name of this Axis.
double	getRelativeBin(org.djunits.value.vdouble.scalar.DoubleScalarInterface value) Compute the floating point bin number for a value.
String	getShortName() Retrieve the short name for this Axis.
double	getValue(int aggregatedBin) Return the value for an aggregated bin number.
void	setCurrentGranularity(double newGranularity) Change the granularity for this axis.
void	setMaximumValue(org.djunits.value.vdouble.scalar.DoubleScalarInterface newMaximumValue) Change the maximum value of this axis.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Axis

public Axis(org.djunits.value.vdouble.scalar.DoubleScalarInterface minimumValue,
            org.djunits.value.vdouble.scalar.DoubleScalarInterface maximumValue,
            double[] granularities,
            double initialGranularity,
            String name,
            String shortName,
            String format)

Create a new AxisDefinition.

Parameters:

minimumValue - DoubleScalar; the minimum value along this axis

maximumValue - DoubleScalar; the maximum value along this axis

granularities - double[]; the aggregation values along this axis (all values must be an integer multiple of the first value)

initialGranularity - double; initial aggregation value (must be one of the values in granularities)

name - String; the name to describe the axis and to name the pop up menu that changes the current granularity

shortName - String; the name identifying this axis for use in a menu

format - String; format string for rendering a value along this axis

Method Detail

getRelativeBin

public double getRelativeBin(org.djunits.value.vdouble.scalar.DoubleScalarInterface value)

Compute the floating point bin number for a value.

Parameters:

value - DoubleScalar; the value

Returns:

double; the bin that belongs to the value

adjustMaximumValue

public void adjustMaximumValue(org.djunits.value.vdouble.scalar.DoubleScalarInterface newMaximum)

Adjust (increase) the range of this AxisDefinition.

Parameters:

newMaximum - DoubleScalar; the new maximum value of the axis

getValue

public double getValue(int aggregatedBin)

Return the value for an aggregated bin number.

Parameters:

aggregatedBin - Integer; the number of a bin

Returns:

Double; the value corresponding to the center of aggregateBin

getAggregatedBinCount

public int getAggregatedBinCount()

Returns:

Integer; the number of bins along this axis

getBinCount

public int getBinCount()

Returns:

Integer; the number of aggregated bins along this axis

getCurrentGranularity

public double getCurrentGranularity()

Get the granularity of this axis.

Returns:

double; the granularity of this axis

setCurrentGranularity

public void setCurrentGranularity(double newGranularity)

Change the granularity for this axis.
The new value must be present in the granularities.

Parameters:

newGranularity - double; the new value for the granularity of this axis

getMaximumValue

public org.djunits.value.vdouble.scalar.DoubleScalarInterface getMaximumValue()

Get the maximum value of this axis.

Returns:

DoubleScalar; the current maximum value of this axis

setMaximumValue

public void setMaximumValue(org.djunits.value.vdouble.scalar.DoubleScalarInterface newMaximumValue)

Change the maximum value of this axis.
The maximum value can only be increased.

Parameters:

newMaximumValue - DoubleScalar; the new maximum value of this axis

getMinimumValue

public org.djunits.value.vdouble.scalar.DoubleScalarInterface getMinimumValue()

Get the minimum value of this axis.

Returns:

DoubleScalar; the minimum value of this axis

getGranularities

public final double[] getGranularities()

Retrieve the possible granularities for this Axis.

Returns:

granularities

getFormat

public String getFormat()

Retrieve the format for displaying values along this Axis.

Returns:

format

getShortName

public String getShortName()

Retrieve the short name for this Axis.

Returns:

String; the short name for this Axis

getName

public String getName()

Retrieve the name of this Axis.

Returns:

String; the name of this Axis

toString

public final String toString()

Overrides:

toString in class Object