Class CoordinateXYM

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Coordinate>

    public class CoordinateXYM
    extends Coordinate
    Coordinate subclass supporting XYM ordinates.

    This data object is suitable for use with coordinate sequences with dimension = 3 and measures = 1.

    The Coordinate.z field is visible, but intended to be ignored.

    Since:
    1.16
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int M
      Standard ordinate index value for M in XYM sequences.
      static int X
      Standard ordinate index value for X
      static int Y
      Standard ordinate index value for Y
      static int Z
      CoordinateXYM does not support Z values.
    • Constructor Summary

      Constructors 
      Constructor Description
      CoordinateXYM()
      Default constructor
      CoordinateXYM​(double x, double y, double m)
      Constructs a CoordinateXYM instance with the given ordinates and measure.
      CoordinateXYM​(Coordinate coord)
      Constructs a CoordinateXYM instance with the x and y ordinates of the given Coordinate.
      CoordinateXYM​(CoordinateXYM coord)
      Constructs a CoordinateXY instance with the x and y ordinates of the given CoordinateXYM.
    • Field Detail

      • M

        public static final int M
        Standard ordinate index value for M in XYM sequences.

        This constant assumes XYM coordinate sequence definition. Check this assumption using #getDimension() and #getMeasures() before use.

        See Also:
        Constant Field Values
    • Constructor Detail

      • CoordinateXYM

        public CoordinateXYM()
        Default constructor
      • CoordinateXYM

        public CoordinateXYM​(double x,
                             double y,
                             double m)
        Constructs a CoordinateXYM instance with the given ordinates and measure.
        Parameters:
        x - the X ordinate
        y - the Y ordinate
        m - the M measure value
      • CoordinateXYM

        public CoordinateXYM​(Coordinate coord)
        Constructs a CoordinateXYM instance with the x and y ordinates of the given Coordinate.
        Parameters:
        coord - the coordinate providing the ordinates
      • CoordinateXYM

        public CoordinateXYM​(CoordinateXYM coord)
        Constructs a CoordinateXY instance with the x and y ordinates of the given CoordinateXYM.
        Parameters:
        coord - the coordinate providing the ordinates
    • Method Detail

      • copy

        public CoordinateXYM copy()
        Creates a copy of this CoordinateXYM.
        Overrides:
        copy in class Coordinate
        Returns:
        a copy of this CoordinateXYM
      • getM

        public double getM()
        The m-measure, if available.
        Overrides:
        getM in class Coordinate
        Returns:
        the value of the measure, or NaN
      • setM

        public void setM​(double m)
        Description copied from class: Coordinate
        Sets the measure value, if supported.
        Overrides:
        setM in class Coordinate
        Parameters:
        m - the value to set as M
      • getZ

        public double getZ()
        The z-ordinate is not supported
        Overrides:
        getZ in class Coordinate
        Returns:
        the value of the Z ordinate, or NaN
      • setZ

        public void setZ​(double z)
        The z-ordinate is not supported
        Overrides:
        setZ in class Coordinate
        Parameters:
        z - the value to set as Z
      • setCoordinate

        public void setCoordinate​(Coordinate other)
        Description copied from class: Coordinate
        Sets this Coordinates (x,y,z) values to that of other.
        Overrides:
        setCoordinate in class Coordinate
        Parameters:
        other - the Coordinate to copy
      • getOrdinate

        public double getOrdinate​(int ordinateIndex)
        Description copied from class: Coordinate
        Gets the ordinate value for the given index. The base implementation supports values for the index are Coordinate.X, Coordinate.Y, and Coordinate.Z.
        Overrides:
        getOrdinate in class Coordinate
        Parameters:
        ordinateIndex - the ordinate index
        Returns:
        the value of the ordinate
      • setOrdinate

        public void setOrdinate​(int ordinateIndex,
                                double value)
        Description copied from class: Coordinate
        Sets the ordinate for the given index to a given value. The base implementation supported values for the index are Coordinate.X, Coordinate.Y, and Coordinate.Z.
        Overrides:
        setOrdinate in class Coordinate
        Parameters:
        ordinateIndex - the ordinate index
        value - the value to set
      • toString

        public java.lang.String toString()
        Description copied from class: Coordinate
        Returns a String of the form (x,y,z) .
        Overrides:
        toString in class Coordinate
        Returns:
        a String of the form (x,y,z)