sgtplot.dm

Class SGT3DVector

java.lang.Object

sgtplot.dm.SGTVector

sgtplot.dm.SGT3DVector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, SGTData

public class SGT3DVector
extends SGTVector

Defines a data object to be a Vector. Interpretation of U and V is determined by the CoordinateSystem. For Cartesian, U and V are the Cartesian vector components. For Polar , U and V are R (radius) and Theta (angle) vector components, respectively.

Since:

1.0

See Also:

SGTData, CoordinateSystem, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SGT3DVector() Default constructor.
SGT3DVector(SGTGrid uComp, SGTGrid vComp, SGTGrid wComp) Construct a SGTVector from two components.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Add a PropertyChangeListener to the listener list.
SGTData	copy() Create a copy.
java.lang.String	getId() Get the unique identifier.
SGTGrid	getW() Get the W component.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Remove a PropertyChangeListener from the listener list.
void	setComponents(SGTGrid uComp, SGTGrid vComp, SGTGrid wComp) Set the vector components.
void	setId(java.lang.String ident) Set the unique identifier.
void	setU(SGTGrid wComp) Set the W component.

Methods inherited from class sgtplot.dm.SGTVector

getKeyTitle, getTitle, getU, getV, getXMetaData, getXRange, getYMetaData, getYRange, isXTime, isYTime, setComponents, setKeyTitle, setTitle, setV

Methods inherited from class java.lang.Object

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

Constructor Detail

SGT3DVector

public SGT3DVector()

Default constructor.

SGT3DVector

public SGT3DVector(SGTGrid uComp,
                   SGTGrid vComp,
                   SGTGrid wComp)

Construct a SGTVector from two components. The two components must match in both SGTData and CoordinateSystem Interfaces. Both components must be the same shape.

Parameters:

uComp - U component of the vector

vComp - V component of the vector

vComp - W component of the vector

Method Detail

copy

public SGTData copy()

Create a copy. Creates a shallow copy.

Specified by:

copy in interface SGTData

Overrides:

copy in class SGTVector

Returns:

shallow copy

See Also:

SGTData

getW

public SGTGrid getW()

Get the W component.

Returns:

W component

setU

public void setU(SGTGrid wComp)

Set the W component.

Overrides:

setU in class SGTVector

Parameters:

uComp - W component

setComponents

public void setComponents(SGTGrid uComp,
                          SGTGrid vComp,
                          SGTGrid wComp)

Set the vector components.

Parameters:

uComp - U component

vComp - V component

getId

public java.lang.String getId()

Get the unique identifier. The presence of the identifier is optional, but if it is present it should be unique. This field is used to search for the layer that contains the data.

Specified by:

getId in interface SGTData

Overrides:

getId in class SGTVector

Returns:

unique identifier

See Also:

Pane, Layer

setId

public void setId(java.lang.String ident)

Set the unique identifier.

Overrides:

setId in class SGTVector

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Description copied from interface: SGTData

Add a PropertyChangeListener to the listener list.

Specified by:

addPropertyChangeListener in interface SGTData

Overrides:

addPropertyChangeListener in class SGTVector

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Description copied from interface: SGTData

Remove a PropertyChangeListener from the listener list.

Specified by:

removePropertyChangeListener in interface SGTData

Overrides:

removePropertyChangeListener in class SGTVector