CoordinateSequence

trait CoordinateSequence extends Cloneable
Companion
object
trait Cloneable
class Object
trait Matchable
class Any

Value members

Abstract methods

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

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

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

Value Params
env

the envelope to expand return a ref to the expanded envelope

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.

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.

Value Params
i

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

def getCoordinate(index: Int, coord: Coordinate): Unit

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

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

Value Params
coord

a { @link Coordinate} to receive the value

index

the index of the coordinate to copy

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.

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.

Value Params
i

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

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.

def getOrdinate(index: Int, ordinateIndex: Int): Double

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

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()}).

Value Params
index

the coordinate index in the sequence

ordinateIndex

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

def getX(index: Int): Double

Returns ordinate X (0) of the specified coordinate.

Returns ordinate X (0) of the specified coordinate.

Value Params
index

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

def getY(index: Int): Double

Returns ordinate Y (1) of the specified coordinate.

Returns ordinate Y (1) of the specified coordinate.

Value Params
index

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

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.

Value Params
index

the coordinate index in the sequence

ordinateIndex

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

value

the new ordinate value

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

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.

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 methods

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

def getM(index: Int): Double

Returns ordinate M of the specified coordinate if available.

Returns ordinate M of the specified coordinate if available.

Value Params
index

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

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

def getZ(index: Int): Double

Returns ordinate Z of the specified coordinate if available.

Returns ordinate Z of the specified coordinate if available.

Value Params
index

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

def hasM: Boolean

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.

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)

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.