Public Member Functions

geos::geom::CoordinateArraySequence Class Reference

The default implementation of CoordinateSequence. More...

#include <CoordinateArraySequence.h>

Inheritance diagram for geos::geom::CoordinateArraySequence:
geos::geom::CoordinateSequence

List of all members.

Public Member Functions

 CoordinateArraySequence (const CoordinateArraySequence &cl)
CoordinateSequenceclone () const
 Returns a deep copy of this collection.
const CoordinategetAt (size_t pos) const
 Returns a read-only reference to Coordinate at position i.
virtual void getAt (size_t i, Coordinate &c) const
 Copy Coordinate at position i to Coordinate c.
size_t getSize () const
 Returns the number of Coordinates (actual or otherwise, as this implementation may not store its data in Coordinate objects).
const std::vector< Coordinate > * toVector () const
 Returns a read-only vector with the Coordinates in this collection.
void toVector (std::vector< Coordinate > &) const
 Pushes all Coordinates of this sequence onto the provided vector.
 CoordinateArraySequence ()
 Construct an empty sequence.
 CoordinateArraySequence (std::vector< Coordinate > *coords)
 Construct sequence taking ownership of given Coordinate vector.
 CoordinateArraySequence (size_t n)
 Construct sequence allocating space for n coordinates.
bool isEmpty () const
 Returns true it list contains no coordinates.
void add (const Coordinate &c)
 Add a Coordinate to the list.
virtual void add (const Coordinate &c, bool allowRepeated)
 Add a coordinate.
virtual void add (size_t i, const Coordinate &coord, bool allowRepeated)
 Inserts the specified coordinate at the specified position in this list.
void setAt (const Coordinate &c, size_t pos)
 Get a reference to Coordinate at position pos.
void deleteAt (size_t pos)
 Delete Coordinate at position pos (list will shrink).
std::string toString () const
 Get a string rapresentation of CoordinateSequence.
void setPoints (const std::vector< Coordinate > &v)
 Substitute Coordinate list with a copy of the given vector.
double getOrdinate (size_t index, size_t ordinateIndex) const
void setOrdinate (size_t index, size_t ordinateIndex, double value)
void expandEnvelope (Envelope &env) const
size_t getDimension () const
void apply_rw (const CoordinateFilter *filter)
void apply_ro (CoordinateFilter *filter) const
virtual CoordinateSequenceremoveRepeatedPoints ()
 Remove consecutive equal Coordinates from the sequence.

Detailed Description

The default implementation of CoordinateSequence.


Member Function Documentation

virtual void geos::geom::CoordinateArraySequence::add ( const Coordinate c,
bool  allowRepeated 
) [virtual]

Add a coordinate.

Parameters:
c The coordinate to add
allowRepeated if set to false, repeated coordinates are collapsed
Returns:
true (as by general collection contract)

Reimplemented from geos::geom::CoordinateSequence.

virtual void geos::geom::CoordinateArraySequence::add ( size_t  i,
const Coordinate coord,
bool  allowRepeated 
) [virtual]

Inserts the specified coordinate at the specified position in this list.

Parameters:
i the position at which to insert
coord the coordinate to insert
allowRepeated if set to false, repeated coordinates are collapsed

NOTE: this is a CoordinateList interface in JTS

Implements geos::geom::CoordinateSequence.

void geos::geom::CoordinateArraySequence::expandEnvelope ( Envelope env  )  const [virtual]

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

Parameters:
env the envelope to expand

Reimplemented from geos::geom::CoordinateSequence.

const Coordinate& geos::geom::CoordinateArraySequence::getAt ( size_t  i  )  const [virtual]

Returns a read-only reference to Coordinate at position i.

Whether or not the Coordinate returned is the actual underlying Coordinate or merely a copy depends on the implementation.

Implements geos::geom::CoordinateSequence.

size_t geos::geom::CoordinateArraySequence::getDimension (  )  const [inline, virtual]

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

Returns:
the dimension of the sequence.

Implements geos::geom::CoordinateSequence.

double geos::geom::CoordinateArraySequence::getOrdinate ( size_t  index,
size_t  ordinateIndex 
) const [virtual]

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

Parameters:
index the coordinate index in the sequence
ordinateIndex the ordinate index in the coordinate (in range [0, dimension-1])

Implements geos::geom::CoordinateSequence.

virtual CoordinateSequence& geos::geom::CoordinateArraySequence::removeRepeatedPoints (  )  [virtual]

Remove consecutive equal Coordinates from the sequence.

Equality test is 2D based. Returns a reference to self.

Implements geos::geom::CoordinateSequence.

void geos::geom::CoordinateArraySequence::setAt ( const Coordinate c,
size_t  pos 
) [virtual]

Get a reference to Coordinate at position pos.

Copy Coordinate c to position pos

Implements geos::geom::CoordinateSequence.

void geos::geom::CoordinateArraySequence::setOrdinate ( size_t  index,
size_t  ordinateIndex,
double  value 
) [virtual]

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

Parameters:
index the coordinate index in the sequence
ordinateIndex the ordinate index in the coordinate (in range [0, dimension-1])
value the new ordinate value

Implements geos::geom::CoordinateSequence.

void geos::geom::CoordinateArraySequence::toVector ( std::vector< Coordinate > &  coords  )  const [virtual]

Pushes all Coordinates of this sequence onto the provided vector.

This method is a port of the toCoordinateArray() method of JTS.

Implements geos::geom::CoordinateSequence.

const std::vector<Coordinate>* geos::geom::CoordinateArraySequence::toVector (  )  const [virtual]

Returns a read-only vector with 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.

This method is a port of the toCoordinateArray() method of JTS. It is not much used as memory management requires us to know wheter we should or not delete the returned object in a consistent way. Our options are: use shared_ptr<Coordinate> or always keep ownerhips of an eventual newly created vector. We opted for the second, so the returned object is a const, to also ensure that returning an internal pointer doesn't make the object mutable.

Deprecated:
use toVector(std::vector<Coordinate>&) instead

Implements geos::geom::CoordinateSequence.


The documentation for this class was generated from the following file: