trait CoordinateSequence extends Cloneable

Linear Supertypes
Cloneable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CoordinateSequence
  2. Cloneable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def copy: CoordinateSequence

    Returns a deep copy of this collection.

    Returns a deep copy of this collection.

    return a copy of the coordinate sequence containing copies of all points

  2. abstract def expandEnvelope(env: Envelope): Envelope

    Expands the given {link Envelope} to include the coordinates in the sequence.

    Expands the given {link Envelope} to include the coordinates in the sequence. Allows implementing classes to optimize access to coordinate values.

    env

    the envelope to expand return a ref to the expanded envelope

  3. abstract def getCoordinate(index: Int, coord: Coordinate): Unit

    Copies the i'th coordinate in the sequence to the supplied {link Coordinate}.

    Copies the i'th coordinate in the sequence to the supplied {link Coordinate}. Only the first two dimensions are copied.

    index

    the index of the coordinate to copy

    coord

    a { @link Coordinate} to receive the value

  4. abstract def getCoordinate(i: Int): Coordinate

    Returns (possibly a copy of) the i'th coordinate in this sequence.

    Returns (possibly a copy of) the i'th coordinate in this sequence. Whether or not the Coordinate returned is the actual underlying Coordinate or merely a copy depends on the implementation.

    Note that in the future the semantics of this method may change to guarantee that the Coordinate returned is always a copy. Callers should not to assume that they can modify a CoordinateSequence by modifying the object returned by this method.

    i

    the index of the coordinate to retrieve return the i'th coordinate in the sequence

  5. abstract def getCoordinateCopy(i: Int): Coordinate

    Returns a copy of the i'th coordinate in this sequence.

    Returns a copy of the i'th coordinate in this sequence. This method optimizes the situation where the caller is going to make a copy anyway - if the implementation has already created a new Coordinate object, no further copy is needed.

    i

    the index of the coordinate to retrieve return a copy of the i'th coordinate in the sequence

  6. abstract def getDimension: Int

    Returns the dimension (number of ordinates in each coordinate) for this sequence.

    Returns the dimension (number of ordinates in each coordinate) for this sequence.

    This total includes any measures, indicated by non-zero {link #getMeasures()}.

    return the dimension of the sequence.

  7. abstract def getOrdinate(index: Int, ordinateIndex: Int): Double

    Returns the ordinate of a coordinate in this sequence.

    Returns the ordinate of a coordinate in this sequence. Ordinate indices 0 and 1 are assumed to be X and Y.

    Ordinates indices greater than 1 have user-defined semantics (for instance, they may contain other dimensions or measure values as described by {link #getDimension()} and {link #getMeasures()}).

    index

    the coordinate index in the sequence

    ordinateIndex

    the ordinate index in the coordinate (in range [0, dimension-1])

  8. abstract def getX(index: Int): Double

    Returns ordinate X (0) of the specified coordinate.

    Returns ordinate X (0) of the specified coordinate.

    index

    return the value of the X ordinate in the index'th coordinate

  9. abstract def getY(index: Int): Double

    Returns ordinate Y (1) of the specified coordinate.

    Returns ordinate Y (1) of the specified coordinate.

    index

    return the value of the Y ordinate in the index'th coordinate

  10. abstract def setOrdinate(index: Int, ordinateIndex: Int, value: Double): Unit

    Sets the value for a given ordinate of a coordinate in this sequence.

    Sets the value for a given ordinate of a coordinate in this sequence.

    index

    the coordinate index in the sequence

    ordinateIndex

    the ordinate index in the coordinate (in range [0, dimension-1])

    value

    the new ordinate value

  11. abstract def size: Int

    Returns the number of coordinates in this sequence.

    Returns the number of coordinates in this sequence.

    return the size of the sequence

  12. abstract def toCoordinateArray: Array[Coordinate]

    Returns (possibly copies of) the Coordinates in this collection.

    Returns (possibly copies of) the Coordinates in this collection. Whether or not the Coordinates returned are the actual underlying Coordinates or merely copies depends on the implementation. Note that if this implementation does not store its data as an array of Coordinates, this method will incur a performance penalty because the array needs to be built from scratch.

    return a array of coordinates containing the point values in this sequence

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def createCoordinate: Coordinate

    Creates a coordinate for use in this sequence.

    Creates a coordinate for use in this sequence.

    The coordinate is created supporting the same number of {link #getDimension()} and {link #getMeasures()} as this sequence and is suitable for use with {link #getCoordinate(int, Coordinate)}.

    return coordinate for use with this sequence

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getM(index: Int): Double

    Returns ordinate M of the specified coordinate if available.

    Returns ordinate M of the specified coordinate if available.

    index

    return the value of the M ordinate in the index'th coordinate, or Double.NaN if not defined.

  12. def getMeasures: Int

    Returns the number of measures included in {link #getDimension()} for each coordinate for this sequence.

    Returns the number of measures included in {link #getDimension()} for each coordinate for this sequence.

    For a measured coordinate sequence a non-zero value is returned.

    • For XY sequence measures is zero
    • For XYM sequence measure is one -
    • For XYZ sequence measure is zero
    • For XYZM sequence measure is one
    • Values greater than one are supported

    return the number of measures included in dimension

  13. def getZ(index: Int): Double

    Returns ordinate Z of the specified coordinate if available.

    Returns ordinate Z of the specified coordinate if available.

    index

    return the value of the Z ordinate in the index'th coordinate, or Double.NaN if not defined.

  14. def hasM: Boolean

    Tests whether the coordinates in the sequence have measures associated with them.

    Tests whether the coordinates in the sequence have measures associated with them. Returns true if {link #getMeasures()} > 0. See {link #getMeasures()} to determine the number of measures present.

    return true if { @link #getM(int)} is supported.

    See also

    #getMeasures()

    #getM(int)

  15. def hasZ: Boolean

    Checks {link #getDimension()} and {link #getMeasures()} to determine if {link #getZ(int)} is supported.

    Checks {link #getDimension()} and {link #getMeasures()} to determine if {link #getZ(int)} is supported.

    return true if { @link #getZ(int)} is supported.

  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Cloneable

Inherited from AnyRef

Inherited from Any

Ungrouped