GEOS  3.8.0dev
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
geos::geom::LineString Class Reference

#include <LineString.h>

Inheritance diagram for geos::geom::LineString:
geos::geom::Geometry geos::geom::Lineal geos::geom::Geometry geos::geom::LinearRing

Public Types

typedef std::vector< const
LineString * > 
ConstVect
 A vector of const LineString pointers.
 
- Public Types inherited from geos::geom::Geometry
using ConstVect = std::vector< const Geometry * >
 A vector of const Geometry pointers.
 
using NonConstVect = std::vector< Geometry * >
 A vector of non-const Geometry pointers.
 
using Ptr = std::unique_ptr< Geometry >
 An unique_ptr of Geometry.
 

Public Member Functions

Geometryclone () const override
 Creates and returns a full copy of this LineString object (including all coordinates contained by it) More...
 
CoordinateSequencegetCoordinates () const override
 Returns this Geometry vertices. Caller takes ownership of the returned object.
 
const CoordinateSequencegetCoordinatesRO () const
 Returns a read-only pointer to internal CoordinateSequence.
 
virtual const CoordinategetCoordinateN (size_t n) const
 
Dimension::DimensionType getDimension () const override
 Returns line dimension (1)
 
int getBoundaryDimension () const override
 Returns Dimension::False for a closed LineString, 0 otherwise (LineString boundary is a MultiPoint)
 
int getCoordinateDimension () const override
 Returns coordinate dimension.
 
GeometrygetBoundary () const override
 Returns a MultiPoint. Empty for closed LineString, a Point for each vertex otherwise.
 
bool isEmpty () const override
 Returns whether or not the set of points in this Geometry is empty.
 
std::size_t getNumPoints () const override
 Returns the count of this Geometrys vertices.
 
virtual PointgetPointN (std::size_t n) const
 
virtual PointgetStartPoint () const
 Return the start point of the LineString or NULL if this is an EMPTY LineString.
 
virtual PointgetEndPoint () const
 Return the end point of the LineString or NULL if this is an EMPTY LineString.
 
virtual bool isClosed () const
 
virtual bool isRing () const
 
std::string getGeometryType () const override
 Return a string representation of this Geometry type.
 
GeometryTypeId getGeometryTypeId () const override
 Return an integer representation of this Geometry type.
 
virtual bool isCoordinate (Coordinate &pt) const
 
bool equalsExact (const Geometry *other, double tolerance=0) const override
 Returns true iff the two Geometrys are of the same type and their vertices corresponding by index are equal up to a specified tolerance.
 
void apply_rw (const CoordinateFilter *filter) override
 
void apply_ro (CoordinateFilter *filter) const override
 
void apply_rw (GeometryFilter *filter) override
 
void apply_ro (GeometryFilter *filter) const override
 
void apply_rw (GeometryComponentFilter *filter) override
 
void apply_ro (GeometryComponentFilter *filter) const override
 
void apply_rw (CoordinateSequenceFilter &filter) override
 
void apply_ro (CoordinateSequenceFilter &filter) const override
 
void normalize () override
 Normalizes a LineString. More...
 
int compareToSameClass (const Geometry *ls) const override
 
const CoordinategetCoordinate () const override
 Returns a vertex of this Geometry, or NULL if this is the empty geometry.
 
double getLength () const override
 Returns the length of this Geometry.
 
Geometryreverse () const override
 
- Public Member Functions inherited from geos::geom::Geometry
virtual ~Geometry ()
 Destroy Geometry and all components.
 
const GeometryFactorygetFactory () const
 Gets the factory which contains the context in which this geometry was created. More...
 
void setUserData (void *newUserData)
 A simple scheme for applications to add their own custom data to a Geometry. An example use might be to add an object representing a Coordinate Reference System. More...
 
void * getUserData () const
 Gets the user data object for this geometry, if any. More...
 
virtual int getSRID () const
 
virtual void setSRID (int newSRID)
 
const PrecisionModelgetPrecisionModel () const
 Get the PrecisionModel used to create this Geometry.
 
virtual bool isSimple () const
 Returns false if the Geometry not simple.
 
virtual std::size_t getNumGeometries () const
 
virtual const GeometrygetGeometryN (std::size_t) const
 
virtual bool isValid () const
 Tests the validity of this Geometry. More...
 
virtual bool isRectangle () const
 Polygon overrides to check for actual rectangle.
 
virtual GeometrygetEnvelope () const
 Returns this Geometrys bounding box.
 
virtual const EnvelopegetEnvelopeInternal () const
 Returns the minimum and maximum x and y values in this Geometry, or a null Envelope if this Geometry is empty.
 
virtual bool disjoint (const Geometry *other) const
 
virtual bool touches (const Geometry *other) const
 Returns true if the DE-9IM intersection matrix for the two Geometrys is FT*******, F**T***** or F***T****.
 
virtual bool intersects (const Geometry *g) const
 Returns true if disjoint returns false.
 
virtual bool crosses (const Geometry *g) const
 
virtual bool within (const Geometry *g) const
 Returns true if the DE-9IM intersection matrix for the two Geometrys is T*F**F***.
 
virtual bool contains (const Geometry *g) const
 Returns true if other.within(this) returns true.
 
virtual bool overlaps (const Geometry *g) const
 Returns true if the DE-9IM intersection matrix for the two Geometrys is T*T***T** (for two points or two surfaces) 1*T***T** (for two curves).
 
virtual bool relate (const Geometry *g, const std::string &intersectionPattern) const
 Returns true if the elements in the DE-9IM intersection matrix for the two Geometrys match the elements in intersectionPattern. More...
 
bool relate (const Geometry &g, const std::string &intersectionPattern) const
 
virtual IntersectionMatrixrelate (const Geometry *g) const
 Returns the DE-9IM intersection matrix for the two Geometrys.
 
IntersectionMatrixrelate (const Geometry &g) const
 
virtual bool equals (const Geometry *g) const
 Returns true if the DE-9IM intersection matrix for the two Geometrys is T*F**FFF*.
 
bool covers (const Geometry *g) const
 Returns true if this geometry covers the specified geometry. More...
 
bool coveredBy (const Geometry *g) const
 Tests whether this geometry is covered by the specified geometry. More...
 
virtual std::string toString () const
 Returns the Well-known Text representation of this Geometry.
 
virtual std::string toText () const
 
virtual Geometrybuffer (double distance) const
 Returns a buffer region around this Geometry having the given width. More...
 
virtual Geometrybuffer (double distance, int quadrantSegments) const
 Returns a buffer region around this Geometry having the given width and with a specified number of segments used to approximate curves. More...
 
virtual Geometrybuffer (double distance, int quadrantSegments, int endCapStyle) const
 Computes a buffer area around this geometry having the given width and with a specified accuracy of approximation for circular arcs, and using a specified end cap style. More...
 
virtual GeometryconvexHull () const
 Returns the smallest convex Polygon that contains all the points in the Geometry.
 
virtual Geometryintersection (const Geometry *other) const
 Returns a Geometry representing the points shared by this Geometry and other. More...
 
GeometryUnion (const Geometry *other) const
 Returns a Geometry representing all the points in this Geometry and other. More...
 
Ptr Union () const
 
virtual Geometrydifference (const Geometry *other) const
 Returns a Geometry representing the points making up this Geometry that do not make up other. More...
 
virtual GeometrysymDifference (const Geometry *other) const
 Returns a set combining the points in this Geometry not in other, and the points in other not in this Geometry. More...
 
template<class T >
void applyComponentFilter (T &f) const
 Apply a fiter to each component of this geometry. The filter is expected to provide a .filter(const Geometry*) method. More...
 
virtual int compareTo (const Geometry *geom) const
 
virtual double distance (const Geometry *g) const
 Returns the minimum distance between this Geometry and the Geometry g.
 
virtual double getArea () const
 Returns the area of this Geometry.
 
virtual bool isWithinDistance (const Geometry *geom, double cDistance) const
 Tests whether the distance from this Geometry to another is less than or equal to a specified value. More...
 
virtual PointgetCentroid () const
 Computes the centroid of this Geometry. More...
 
virtual bool getCentroid (Coordinate &ret) const
 Computes the centroid of this Geometry as a Coordinate. More...
 
virtual PointgetInteriorPoint () const
 Computes an interior point of this Geometry. More...
 
virtual void geometryChanged ()
 
void geometryChangedAction ()
 Notifies this Geometry that its Coordinates have been changed by an external party.
 

Protected Member Functions

 LineString (const LineString &ls)
 
 LineString (CoordinateSequence *pts, const GeometryFactory *newFactory)
 Constructs a LineString taking ownership the given CoordinateSequence.
 
 LineString (CoordinateSequence::Ptr pts, const GeometryFactory *newFactory)
 Hopefully cleaner version of the above.
 
Envelope::Ptr computeEnvelopeInternal () const override
 
int getSortIndex () const override
 
- Protected Member Functions inherited from geos::geom::Geometry
virtual bool isEquivalentClass (const Geometry *other) const
 Returns whether the two Geometrys are equal, from the point of view of the equalsExact method.
 
int compare (std::vector< Coordinate > a, std::vector< Coordinate > b) const
 
int compare (std::vector< Geometry * > a, std::vector< Geometry * > b) const
 
bool equal (const Coordinate &a, const Coordinate &b, double tolerance) const
 
 Geometry (const Geometry &geom)
 Polygon overrides to check for actual rectangle. More...
 
 Geometry (const GeometryFactory *factory)
 Construct a geometry with the given GeometryFactory. More...
 

Protected Attributes

CoordinateSequence::Ptr points
 
- Protected Attributes inherited from geos::geom::Geometry
std::unique_ptr< Envelopeenvelope
 The bounding box of this Geometry.
 
int SRID
 

Friends

class GeometryFactory
 

Additional Inherited Members

- Static Protected Member Functions inherited from geos::geom::Geometry
static bool hasNonEmptyElements (const std::vector< Geometry * > *geometries)
 Returns true if the array contains any non-empty Geometrys.
 
static bool hasNullElements (const CoordinateSequence *list)
 Returns true if the CoordinateSequence contains any null elements.
 
static bool hasNullElements (const std::vector< Geometry * > *lrs)
 Returns true if the vector contains any null elements.
 
static void checkNotGeometryCollection (const Geometry *g)
 

Detailed Description

Models an OGC-style LineString.

A LineString consists of a sequence of two or more vertices, along with all points along the linearly-interpolated curves (line segments) between each pair of consecutive vertices. Consecutive vertices may be equal. The line segments in the line may intersect each other (in other words, the linestring may "curl back" in itself and self-intersect). Linestrings with exactly two identical points are invalid.

A linestring must have either 0 or 2 or more points. If these conditions are not met, the constructors throw an IllegalArgumentException.

Member Function Documentation

void geos::geom::LineString::apply_ro ( CoordinateSequenceFilter filter) const
overridevirtual

Performs a read-only operation on the coordinates in this Geometry's CoordinateSequences.

Parameters
filterthe filter to apply

Implements geos::geom::Geometry.

void geos::geom::LineString::apply_rw ( CoordinateSequenceFilter filter)
overridevirtual

Performs an operation on the coordinates in this Geometry's CoordinateSequences. If the filter reports that a coordinate value has been changed, geometryChanged will be called automatically.

Parameters
filterthe filter to apply

Implements geos::geom::Geometry.

Geometry * geos::geom::LineString::clone ( ) const
inlineoverridevirtual

Creates and returns a full copy of this LineString object (including all coordinates contained by it)

Returns
A clone of this instance

Implements geos::geom::Geometry.

void geos::geom::LineString::normalize ( )
overridevirtual

Normalizes a LineString.

A normalized linestring has the first point which is not equal to its reflected point less than the reflected point.

Implements geos::geom::Geometry.

Geometry* geos::geom::LineString::reverse ( ) const
overridevirtual

Creates a LineString whose coordinates are in the reverse order of this object's

Returns
a LineString with coordinates in the reverse order

Implements geos::geom::Geometry.


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