Class CubeDataGeom

  • All Implemented Interfaces:
    DataGeom

    public class CubeDataGeom
    extends java.lang.Object
    implements DataGeom
    Defines positional data coordinates used by a 3-D Cartesian plot. Singleton class.
    Since:
    20 Feb 2013
    Author:
    Mark Taylor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getDataDimCount()
      Returns 3.
      Coord[] getPosCoords()
      Returns the definitions for the user-supplied coordinates that indicate plot positions.
      java.lang.String getVariantName()
      Returns a label for this DataGeom.
      boolean hasPosition()
      Indicates whether the values read by the readDataPos method correspond to a point position in the data space.
      boolean readDataPos​(Tuple tuple, int ic, double[] dpos)
      Determines the positional coordinates in data space for a supplied tuple.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getDataDimCount

        public int getDataDimCount()
        Returns 3.
        Specified by:
        getDataDimCount in interface DataGeom
        Returns:
        number of elements in data space coordinate array
      • hasPosition

        public boolean hasPosition()
        Description copied from interface: DataGeom
        Indicates whether the values read by the readDataPos method correspond to a point position in the data space. If true, a successful read will result in a position array with a definite value for each coordinate. If false, some of the coordinates may be NaN. A false return value would be appropriate for instance if each tuple row for the plot layer represented by this geom corresponds to a line rather than a point in the data space.
        Specified by:
        hasPosition in interface DataGeom
        Returns:
        true iff this geom represents point positions
      • getVariantName

        public java.lang.String getVariantName()
        Description copied from interface: DataGeom
        Returns a label for this DataGeom. It may be used to distinguish from other geoms used in the same plot type, so for instance call it "Cartesian" or "Polar" rather than "Plane" if it's X,Y.
        Specified by:
        getVariantName in interface DataGeom
        Returns:
        user-directed input coordinate type name
      • getPosCoords

        public Coord[] getPosCoords()
        Description copied from interface: DataGeom
        Returns the definitions for the user-supplied coordinates that indicate plot positions.
        Specified by:
        getPosCoords in interface DataGeom
        Returns:
        coordinate quantity array for this geometry
      • readDataPos

        public boolean readDataPos​(Tuple tuple,
                                   int ic,
                                   double[] dpos)
        Description copied from interface: DataGeom
        Determines the positional coordinates in data space for a supplied tuple.

        A parameter supplies the index of the field in the tuple at which the positional coordinate(s) can be found. Each position is represented by DataGeom.getPosCoords() columns of the tuple. By convention positions are at the start of the tuple, so if there is one position in the tuple it will be at icol=0, and there are multiple positions the N'th one will be at icol=N*getPosCoords().

        An array of (at least) DataGeom.getDataDimCount() elements is supplied, and on success the data space coordinate values are written into it.

        Specified by:
        readDataPos in interface DataGeom
        Parameters:
        tuple - coordinate tuple
        ic - column index in tuple at which the positional information starts
        dpos - array into which data space coordinates are written
        Returns:
        true iff conversion was successful