/*
 * $Id: SGT3DVector.java,v 1.3 2003/08/22 23:02:38 dwd Exp $
 *
 * This software is provided by NOAA for full, free and open release.  It is
 * understood by the recipient/user that NOAA assumes no liability for any
 * errors contained in the code.  Although this software is released without
 * conditions or restrictions in its use, it is expected that appropriate
 * credit be given to its author and to the National Oceanic and Atmospheric
 * Administration should the software be included by the recipient as an
 * element in other product development.
 */

package sgtplot.dm;


import java.beans.PropertyChangeListener;
import java.io.Serializable;

import sgtplot.SGLabel;
import sgtplot.util.SoTRange;

/**
 * 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.
 *
 * @author Donald Denbo
 * @version $Revision: 1.3 $, $Date: 2003/08/22 23:02:38 $
 * @since 1.0
 * @see SGTData
 * @see CoordinateSystem
 */
public class SGT3DVector extends SGTVector {
    /**@shapeType AggregationLink
  * @clientRole w comp*/
    SGTGrid wComp_;
  /**
   * Default constructor.
   */
  public SGT3DVector() {
  }
  /**
   * Construct a SGTVector from two components. The two components
   * must match in both SGTData and CoordinateSystem Interfaces.
   * Both components must be the same shape.
   *
   * @param uComp U component of the vector
   * @param vComp V component of the vector
   * @param vComp W component of the vector
   */
  public SGT3DVector(SGTGrid uComp,SGTGrid vComp, SGTGrid wComp) {
    uComp_ = uComp;
    vComp_ = vComp;
    wComp_ = wComp;
  }
  /**
   * Create a copy. Creates a shallow copy.
   *
   * @see SGTData
   */
  public SGTData copy() {
    SGT3DVector newSGTVector;
    try {
      newSGTVector = (SGT3DVector)clone();
    } catch (CloneNotSupportedException e) {
      newSGTVector = new SGT3DVector(this.uComp_, this.vComp_, this.wComp_);
    }
    return (SGTData)newSGTVector;
  }
  /**
   * Get the W component.
   *
   * @return W component
   */
  public SGTGrid getW() {
    return wComp_;
  }

  /**
   * Set the W component.
   *
   * @param uComp W component
   */
  public void setU(SGTGrid wComp) {
    wComp_ = wComp;
  }

  /**
   * Set the vector components.
   *
   * @param uComp U component
   * @param vComp V component
   */
  public void setComponents(SGTGrid uComp, SGTGrid vComp, SGTGrid wComp) {
    uComp_ = uComp;
    vComp_ = vComp;
    wComp_ = wComp;
  }

  /**
   * 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.
   *
   * @return unique identifier
   * @see sgtplot.Pane
   * @see sgtplot.Layer
   */
  public String getId() {
    return id_;
  }
  /**
   * Set the unique identifier.
   */
  public void setId(String ident) {
    id_ = ident;
  }


  public void addPropertyChangeListener(PropertyChangeListener l) {
    uComp_.addPropertyChangeListener(l);
    vComp_.addPropertyChangeListener(l);
    wComp_.addPropertyChangeListener(l);
  }
  public void removePropertyChangeListener(PropertyChangeListener l) {
    uComp_.removePropertyChangeListener(l);
    vComp_.removePropertyChangeListener(l);
    wComp_.removePropertyChangeListener(l);
  }
}