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

#include <LineString.h>

Inheritance diagram for geos::geom::LineString:
[legend]
Collaboration diagram for geos::geom::LineString:
[legend]

Public Types

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

Public Member Functions

 ~LineString () override
 
std::unique_ptr< Geometryclone () const override
 Creates and returns a full copy of this LineString object (including all coordinates contained by it) More...
 
std::unique_ptr< CoordinateSequencegetCoordinates () const override
 Returns this Geometry vertices. Caller takes ownership of the returned object. More...
 
const CoordinateSequencegetCoordinatesRO () const
 Returns a read-only pointer to internal CoordinateSequence. More...
 
virtual const CoordinategetCoordinateN (size_t n) const
 
Dimension::DimensionType getDimension () const override
 Returns line dimension (1) More...
 
int getBoundaryDimension () const override
 Returns Dimension::False for a closed LineString, 0 otherwise (LineString boundary is a MultiPoint) More...
 
uint8_t getCoordinateDimension () const override
 Returns coordinate dimension. More...
 
std::unique_ptr< GeometrygetBoundary () const override
 Returns a MultiPoint. Empty for closed LineString, a Point for each vertex otherwise. More...
 
bool isEmpty () const override
 Returns whether or not the set of points in this Geometry is empty. More...
 
std::size_t getNumPoints () const override
 Returns the count of this Geometrys vertices. More...
 
virtual std::unique_ptr< PointgetPointN (std::size_t n) const
 
virtual std::unique_ptr< PointgetStartPoint () const
 Return the start point of the LineString or NULL if this is an EMPTY LineString. More...
 
virtual std::unique_ptr< PointgetEndPoint () const
 Return the end point of the LineString or NULL if this is an EMPTY LineString. More...
 
virtual bool isClosed () const
 
virtual bool isRing () const
 
std::string getGeometryType () const override
 Return a string representation of this Geometry type. More...
 
GeometryTypeId getGeometryTypeId () const override
 Return an integer representation of this Geometry type. More...
 
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. More...
 
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. More...
 
double getLength () const override
 Returns the length of this Geometry. More...
 
std::unique_ptr< Geometryreverse () const override
 
- Public Member Functions inherited from geos::geom::Geometry
virtual ~Geometry ()
 Destroy Geometry and all components. More...
 
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
 Returns the ID of the Spatial Reference System used by the Geometry. More...
 
virtual void setSRID (int newSRID)
 Sets the ID of the Spatial Reference System used by the Geometry. More...
 
const PrecisionModelgetPrecisionModel () const
 Get the PrecisionModel used to create this Geometry. More...
 
virtual bool isSimple () const
 Returns false if the Geometry not simple. More...
 
virtual std::size_t getNumGeometries () const
 
virtual const GeometrygetGeometryN (std::size_t) const
 Returns a pointer to the nth Geometry in this collection (or self if this is not a collection) More...
 
virtual bool isValid () const
 Tests the validity of this Geometry. More...
 
virtual bool isRectangle () const
 Polygon overrides to check for actual rectangle. More...
 
virtual bool isDimensionStrict (Dimension::DimensionType d) const
 Checks whether this Geometry consists only of components having dimension d. More...
 
bool isPuntal () const
 
bool isLineal () const
 
bool isPolygonal () const
 
bool isCollection () const
 
virtual std::unique_ptr< GeometrygetEnvelope () const
 Returns this Geometrys bounding box. More...
 
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. More...
 
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****. More...
 
virtual bool intersects (const Geometry *g) const
 Returns true if disjoint returns false. More...
 
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***. More...
 
virtual bool contains (const Geometry *g) const
 Returns true if other.within(this) returns true. More...
 
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). More...
 
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
 
std::unique_ptr< IntersectionMatrixrelate (const Geometry *g) const
 Returns the DE-9IM intersection matrix for the two Geometrys. More...
 
std::unique_ptr< 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*. More...
 
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. More...
 
virtual std::string toText () const
 
std::unique_ptr< Geometrybuffer (double distance) const
 
std::unique_ptr< 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...
 
std::unique_ptr< 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 std::unique_ptr< GeometryconvexHull () const
 Returns the smallest convex Polygon that contains all the points in the Geometry. More...
 
std::unique_ptr< Geometryintersection (const Geometry *other) const
 Returns a Geometry representing the points shared by this Geometry and other. More...
 
std::unique_ptr< GeometryUnion (const Geometry *other) const
 Returns a Geometry representing all the points in this Geometry and other. More...
 
Ptr Union () const
 Computes the union of all the elements of this geometry. Heterogeneous GeometryCollections are fully supported. More...
 
std::unique_ptr< Geometrydifference (const Geometry *other) const
 Returns a Geometry representing the points making up this Geometry that do not make up other. More...
 
std::unique_ptr< 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 filter 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
 Comparator for sorting geometry. More...
 
virtual double distance (const Geometry *g) const
 Returns the minimum distance between this Geometry and the Geometry g. More...
 
virtual double getArea () const
 Returns the area of this Geometry. More...
 
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 std::unique_ptr< 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...
 
std::unique_ptr< PointgetInteriorPoint () const
 Computes an interior point of this Geometry. More...
 
virtual void geometryChanged ()
 Notifies this Geometry that its Coordinates have been changed by an external party (using a CoordinateFilter, for example). More...
 
void geometryChangedAction ()
 Notifies this Geometry that its Coordinates have been changed by an external party. More...
 

Protected Member Functions

 LineString (const LineString &ls)
 
 LineString (CoordinateSequence *pts, const GeometryFactory *newFactory)
 Constructs a LineString taking ownership the given CoordinateSequence. More...
 
 LineString (CoordinateSequence::Ptr &&pts, const GeometryFactory &newFactory)
 Hopefully cleaner version of the above. More...
 
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. More...
 
int compare (std::vector< Coordinate > a, std::vector< Coordinate > b) const
 
int compare (std::vector< Geometry * > a, std::vector< Geometry * > b) const
 
int compare (const std::vector< std::unique_ptr< Geometry >> &a, const std::vector< std::unique_ptr< Geometry >> &b) const
 
bool equal (const Coordinate &a, const Coordinate &b, double tolerance) const
 
 Geometry (const Geometry &geom)
 
 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. More...
 
int SRID
 

Private Member Functions

void validateConstruction ()
 
void normalizeClosed ()
 

Friends

class GeometryFactory
 

Additional Inherited Members

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

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 util::IllegalArgumentException.

Definition at line 68 of file LineString.h.

Member Typedef Documentation

typedef std::vector<const LineString*> geos::geom::LineString::ConstVect

A vector of const LineString pointers.

Definition at line 75 of file LineString.h.

Constructor & Destructor Documentation

geos::geom::LineString::~LineString ( )
override
geos::geom::LineString::LineString ( const LineString ls)
protected
geos::geom::LineString::LineString ( CoordinateSequence pts,
const GeometryFactory newFactory 
)
protected

Constructs a LineString taking ownership the given CoordinateSequence.

geos::geom::LineString::LineString ( CoordinateSequence::Ptr &&  pts,
const GeometryFactory newFactory 
)
protected

Hopefully cleaner version of the above.

Member Function Documentation

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

Implements geos::geom::Geometry.

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

Reimplemented from geos::geom::Geometry.

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

Reimplemented from geos::geom::Geometry.

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 ( const CoordinateFilter filter)
overridevirtual

Implements geos::geom::Geometry.

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

Reimplemented from geos::geom::Geometry.

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

Reimplemented from 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.

std::unique_ptr< 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.

Definition at line 227 of file LineString.h.

int geos::geom::LineString::compareToSameClass ( const Geometry ls) const
overridevirtual

Implements geos::geom::Geometry.

Envelope::Ptr geos::geom::LineString::computeEnvelopeInternal ( ) const
overrideprotectedvirtual

Implements geos::geom::Geometry.

bool geos::geom::LineString::equalsExact ( const Geometry other,
double  tolerance = 0 
) const
overridevirtual

Returns true iff the two Geometrys are of the same type and their vertices corresponding by index are equal up to a specified tolerance.

Implements geos::geom::Geometry.

std::unique_ptr<Geometry> geos::geom::LineString::getBoundary ( ) const
overridevirtual

Returns a MultiPoint. Empty for closed LineString, a Point for each vertex otherwise.

Implements geos::geom::Geometry.

int geos::geom::LineString::getBoundaryDimension ( ) const
overridevirtual

Returns Dimension::False for a closed LineString, 0 otherwise (LineString boundary is a MultiPoint)

Implements geos::geom::Geometry.

const Coordinate* geos::geom::LineString::getCoordinate ( ) const
overridevirtual

Returns a vertex of this Geometry, or NULL if this is the empty geometry.

Implements geos::geom::Geometry.

uint8_t geos::geom::LineString::getCoordinateDimension ( ) const
overridevirtual

Returns coordinate dimension.

Implements geos::geom::Geometry.

virtual const Coordinate& geos::geom::LineString::getCoordinateN ( size_t  n) const
virtual
std::unique_ptr<CoordinateSequence> geos::geom::LineString::getCoordinates ( ) const
overridevirtual

Returns this Geometry vertices. Caller takes ownership of the returned object.

Implements geos::geom::Geometry.

Referenced by geos::noding::SegmentStringUtil::extractSegmentStrings().

Here is the caller graph for this function:

const CoordinateSequence* geos::geom::LineString::getCoordinatesRO ( ) const

Returns a read-only pointer to internal CoordinateSequence.

Dimension::DimensionType geos::geom::LineString::getDimension ( ) const
overridevirtual

Returns line dimension (1)

Implements geos::geom::Geometry.

virtual std::unique_ptr<Point> geos::geom::LineString::getEndPoint ( ) const
virtual

Return the end point of the LineString or NULL if this is an EMPTY LineString.

std::string geos::geom::LineString::getGeometryType ( ) const
overridevirtual

Return a string representation of this Geometry type.

Implements geos::geom::Geometry.

GeometryTypeId geos::geom::LineString::getGeometryTypeId ( ) const
overridevirtual

Return an integer representation of this Geometry type.

Implements geos::geom::Geometry.

double geos::geom::LineString::getLength ( ) const
overridevirtual

Returns the length of this Geometry.

Reimplemented from geos::geom::Geometry.

std::size_t geos::geom::LineString::getNumPoints ( ) const
overridevirtual

Returns the count of this Geometrys vertices.

Implements geos::geom::Geometry.

virtual std::unique_ptr<Point> geos::geom::LineString::getPointN ( std::size_t  n) const
virtual
int geos::geom::LineString::getSortIndex ( ) const
inlineoverrideprotectedvirtual

Implements geos::geom::Geometry.

Definition at line 204 of file LineString.h.

References geos::geom::SORTINDEX_LINESTRING.

virtual std::unique_ptr<Point> geos::geom::LineString::getStartPoint ( ) const
virtual

Return the start point of the LineString or NULL if this is an EMPTY LineString.

virtual bool geos::geom::LineString::isClosed ( ) const
virtual

Reimplemented in geos::geom::LinearRing.

virtual bool geos::geom::LineString::isCoordinate ( Coordinate pt) const
virtual
bool geos::geom::LineString::isEmpty ( ) const
overridevirtual

Returns whether or not the set of points in this Geometry is empty.

Implements geos::geom::Geometry.

virtual bool geos::geom::LineString::isRing ( ) const
virtual
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.

void geos::geom::LineString::normalizeClosed ( )
private
std::unique_ptr<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.

void geos::geom::LineString::validateConstruction ( )
private

Friends And Related Function Documentation

friend class GeometryFactory
friend

Definition at line 72 of file LineString.h.

Member Data Documentation

CoordinateSequence::Ptr geos::geom::LineString::points
protected

Definition at line 201 of file LineString.h.


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