at.mug.iqm.api.model

Class PlotModel

java.lang.Object

at.mug.iqm.api.model.AbstractDataModel

at.mug.iqm.api.model.PlotModel

All Implemented Interfaces:

IDataModel, Serializable, Cloneable

public class PlotModel
extends AbstractDataModel

This class is the data-model for plot data, which is stored in the tank. This model can be serialized within an IqmDataBox.

Since:

2012 10 24

Author:

Michael Mayrhofer-R., Philipp Kainz

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Vector<Double>	data The variable for the data values.
private String	dataHeader The variable for the data header (y-axis).
private String	dataUnit The variable for the data unit.
private Vector<Double>	domain The variable for the domain values.
private String	domainHeader The variable for the domain header (x-axis).
private String	domainUnit The variable for the domain units.
private static long	serialVersionUID The UID for serialization.

Fields inherited from class at.mug.iqm.api.model.AbstractDataModel

modelName, properties

Constructor Summary

Constructors

Constructor and Description
PlotModel() Standard Constructor.
PlotModel(String name, String domainHeader, String domainUnit, String dataHeader, String dataUnit, Vector<Double> domain, Vector<Double> data) Directly construct a new PlotModel.
PlotModel(String domainHeader, String domainUnit, String dataHeader, String dataUnit, Vector<Double> domain, Vector<Double> data) Directly construct a new PlotModel.

Method Summary

Modifier and Type	Method and Description
PlotModel	clone()
void	createLinearDomain(Number start, Number end, Number step) Creates a linear domain for a given range.
Vector<Double>	getData() Get the values for the plot's range (y-coordinates).
String	getDataHeader() Get the values for the plot's range (y-coordinates).
String	getDataUnit() Get the values for the plot's range (y-coordinates).
Vector<Double>	getDomain() Get the values for the plot's domain (x-coordinates).
String	getDomainHeader() Get the header description for the plot's domain (x-coordinates).
String	getDomainUnit() Get the unit for the plot's domain (x-coordinates).
void	setData(Vector<Double> data) Set the values for the plot's range (y-coordinates).
void	setDataHeader(String dataHeader) Set the header for the plot's range (y-coordinates).
void	setDataUnit(String dataUnit) Set the unit for the plot's range (y-coordinates).
void	setDomain(Vector<Double> domain) Set the values for the plot's domain (x-coordinates).
void	setDomainHeader(String domainHeader) Set the header description for the plot's domain (x-coordinates).
void	setDomainUnit(String domainUnit) Set the unit for the plot's domain (x-coordinates).

Methods inherited from class at.mug.iqm.api.model.AbstractDataModel

copyProperties, getDataType, getModelName, getProperties, getProperty, setDataType, setModelName, setProperties, setProperty

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The UID for serialization.

See Also:

Constant Field Values

dataHeader

private String dataHeader

The variable for the data header (y-axis).

dataUnit

private String dataUnit

The variable for the data unit.

data

private Vector<Double> data

The variable for the data values.

domainHeader

private String domainHeader

The variable for the domain header (x-axis).

domainUnit

private String domainUnit

The variable for the domain units.

domain

private Vector<Double> domain

The variable for the domain values.

Constructor Detail

PlotModel

public PlotModel()

Standard Constructor. Any values for the variables have to be set manually through setter-methods.

PlotModel

public PlotModel(String domainHeader,
                 String domainUnit,
                 String dataHeader,
                 String dataUnit,
                 Vector<Double> domain,
                 Vector<Double> data)

Directly construct a new PlotModel.

Parameters:

domainHeader - The header of the x-axis. May be null.

domainUnit - The units of the x-axis. May be null.

dataHeader - The header of the y-axis. May be null.

dataUnit - The units of the y-axis. May be null.

domain - The values for the x-axis. Must not be null.

data - The values for the y-axis. Must not be null.

PlotModel

public PlotModel(String name,
                 String domainHeader,
                 String domainUnit,
                 String dataHeader,
                 String dataUnit,
                 Vector<Double> domain,
                 Vector<Double> data)

Directly construct a new PlotModel.

Parameters:

name - The name of the model. Must not be null.

domainHeader - The header of the x-axis. May be null.

domainUnit - The units of the x-axis. May be null.

dataHeader - The header of the y-axis. May be null.

dataUnit - The units of the y-axis. May be null.

domain - The values for the x-axis. Must not be null.

data - The values for the y-axis. Must not be null.

Method Detail

getDataHeader

public String getDataHeader()

Get the values for the plot's range (y-coordinates).

Optional. Header description of the data (i.e. the y-axis): e.g. "velocity" or "v".

setDataHeader

public void setDataHeader(String dataHeader)

Set the header for the plot's range (y-coordinates).

Optional. Header description of the data (i.e. the y-axis): e.g. "velocity" or "v".

Parameters:

dataHeader -

getDataUnit

public String getDataUnit()

Get the values for the plot's range (y-coordinates).

Optional. Unit, the data is represented in: e.g. "km/h".

setDataUnit

public void setDataUnit(String dataUnit)

Set the unit for the plot's range (y-coordinates).

Optional. Unit, the data is represented in: e.g. "km/h".

Parameters:

dataUnit -

getData

public Vector<Double> getData()

Get the values for the plot's range (y-coordinates).

Required. The original series (1 dimensional) data vector in double precision.

setData

public void setData(Vector<Double> data)

Set the values for the plot's range (y-coordinates).

Required. The original series (1 dimensional) data vector in double precision.

Parameters:

data -

getDomainHeader

public String getDomainHeader()

Get the header description for the plot's domain (x-coordinates).

Optional. Header description of the domain (i.e. the x-axis): e.g. "space" or "s".

setDomainHeader

public void setDomainHeader(String domainHeader)

Set the header description for the plot's domain (x-coordinates).

Optional. Header description of the domain (i.e. the x-axis): e.g. "space" or "s".

Parameters:

domainHeader -

getDomainUnit

public String getDomainUnit()

Get the unit for the plot's domain (x-coordinates).

Optional. Unit, the data is represented in: e.g. "km".

setDomainUnit

public void setDomainUnit(String domainUnit)

Set the unit for the plot's domain (x-coordinates).

Optional. Unit, the data is represented in: e.g. "km".

Parameters:

domainUnit -

getDomain

public Vector<Double> getDomain()

Get the values for the plot's domain (x-coordinates).

Optional. A custom (1-dimensional) domain value vector in double precision.

setDomain

public void setDomain(Vector<Double> domain)

Set the values for the plot's domain (x-coordinates).

Optional. A custom (1-dimensional) domain value vector in double precision.

Parameters:

domain -

createLinearDomain

public void createLinearDomain(Number start,
                               Number end,
                               Number step)

Creates a linear domain for a given range.

Parameters:

start - start point

end - end point

step - the step size

clone

public PlotModel clone()
                throws CloneNotSupportedException

Specified by:

clone in class AbstractDataModel

Throws:

CloneNotSupportedException