genopt.gui.chart

Class DataSerie

java.lang.Object

genopt.gui.chart.DataSerie

public class DataSerie
extends java.lang.Object

Object representing a data serie for a chart.

This project was carried out at:

• Lawrence Berkeley National Laboratory (LBNL), Simulation Research Group,

and supported by

• the U.S. Department of Energy (DOE),
• the Swiss Academy of Engineering Sciences (SATW),
• the Swiss National Energy Fund (NEFF), and
• the Swiss National Science Foundation (SNSF)

GenOpt Copyright (c) 1998-2021, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from the U.S. Dept. of Energy). All rights reserved.

Version:

GenOpt(R) 3.1.1 (March 24, 2016)

Author:

Michael Wetter

Field Summary

Fields

Modifier and Type	Field and Description
private java.awt.Color	color color of the line
private java.lang.String	name name of serie
private int	nVal the number of known values (=xVal.length)
private double	xMax maximum x value
private double	xMin minimum x value
private double[]	xVal the x values
private double	yAxiLen y-axis lenght in y units
private java.lang.String	yLab y-axis label
private double	yMax maximum y value
private double	yMin minimum y value
private double[]	yVal the y values

Constructor Summary

Constructors

Constructor and Description
DataSerie(java.lang.String serieLabel, java.lang.String yAxisLabel)

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getColor() gets the color of the serie
java.lang.String	getName() gets the name of the serie
int	getNumberOfValues() gets the number of values
double[]	getX() gets the x values
double	getX(int i) gets the x[i] value
double	getXMax() gets x maximum
double	getXMin() gets x minimum
double[]	getY() gets the y values
double	getY(int i) gets the y[i] value
double	getYAxisLength() gets the y axis length
java.lang.String	getYLabel() gets the y-axis label
double	getYMax() gets y maximum
double	getYMin() gets y minimum
void	setColor(java.awt.Color c) sets the color of the serie
void	setPoints(double[] x, double[] y) sets new data for x and y
protected void	setXExtrema() sets the x extrema
protected void	setYAxisLength(double yMin, double yMax) sets the y-axis length
protected void	setYExtrema() sets the y extrema
protected void	verify(double[] x, double[] y) verifies the validity of x and y

Methods inherited from class java.lang.Object

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

Field Detail

nVal

private int nVal

the number of known values (=xVal.length)

xVal

private double[] xVal

the x values

yVal

private double[] yVal

the y values

xMin

private double xMin

minimum x value

xMax

private double xMax

maximum x value

yMin

private double yMin

minimum y value

yMax

private double yMax

maximum y value

yAxiLen

private double yAxiLen

y-axis lenght in y units

name

private java.lang.String name

name of serie

yLab

private java.lang.String yLab

y-axis label

color

private java.awt.Color color

color of the line

Constructor Detail

DataSerie

public DataSerie(java.lang.String serieLabel,
                 java.lang.String yAxisLabel)

Parameters:

serieLabel - the titel label

yAxisLabel - the y-axis label

Method Detail

setColor

public final void setColor(java.awt.Color c)

sets the color of the serie

Parameters:

c - color of the serie

verify

protected final void verify(double[] x,
                            double[] y)
                     throws java.lang.IllegalArgumentException

verifies the validity of x and y

Parameters:

x - the x-values

y - the y-values

Throws:

java.lang.IllegalArgumentException - if x and y have different field width

setPoints

public final void setPoints(double[] x,
                            double[] y)
                     throws java.lang.IllegalArgumentException

sets new data for x and y

Parameters:

x - the x-values

y - the y-values

Throws:

java.lang.IllegalArgumentException - if x and y have different field width

getXMin

public final double getXMin()

gets x minimum

Returns:

x minimum

getXMax

public final double getXMax()

gets x maximum

Returns:

x maximum

getYMin

public final double getYMin()

gets y minimum

Returns:

y minimum

getYMax

public final double getYMax()

gets y maximum

Returns:

y maximum

getYAxisLength

public final double getYAxisLength()

gets the y axis length

Returns:

the y axis length

setXExtrema

protected final void setXExtrema()

sets the x extrema

setYExtrema

protected final void setYExtrema()

sets the y extrema

getName

public final java.lang.String getName()

gets the name of the serie

Returns:

the name of the serie

getYLabel

public final java.lang.String getYLabel()

gets the y-axis label

Returns:

the y-axis label

getNumberOfValues

public final int getNumberOfValues()

gets the number of values

getX

public final double[] getX()

gets the x values

Returns:

the x values (not as a reference)

getY

public final double[] getY()

gets the y values

Returns:

the y values (not as a reference)

getX

public final double getX(int i)

gets the x[i] value

Returns:

the x[i] value

getY

public final double getY(int i)

gets the y[i] value

Returns:

the y[i] value

getColor

public final java.awt.Color getColor()

gets the color of the serie

Returns:

the color of the serie

setYAxisLength

protected final void setYAxisLength(double yMin,
                                    double yMax)

sets the y-axis length

Parameters:

yMin - the minimum x-value

yMax - the maximum x-value