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

Represents a collection of heterogeneous Geometry objects. More...

#include <geos.h>

Inheritance diagram for geos::geom::GeometryCollection:
geos::geom::Geometry geos::geom::MultiLineString geos::geom::MultiPoint geos::geom::MultiPolygon

Public Types

typedef std::vector
< std::unique_ptr< Geometry >
>::const_iterator 
const_iterator
 
typedef std::vector
< std::unique_ptr< Geometry >
>::iterator 
iterator
 
- 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

const_iterator begin () const
 
const_iterator end () const
 
std::unique_ptr< Geometryclone () const override
 
void setSRID (int) override
 Sets the ID of the Spatial Reference System used by the Geometry.
 
std::unique_ptr
< CoordinateSequence
getCoordinates () const override
 Collects all coordinates of all subgeometries into a CoordinateSequence. More...
 
bool isEmpty () const override
 Returns whether or not the set of points in this Geometry is empty.
 
Dimension::DimensionType getDimension () const override
 Returns the maximum dimension of geometries in this collection (0=point, 1=line, 2=surface) More...
 
bool isDimensionStrict (Dimension::DimensionType d) const override
 Checks whether this Geometry consists only of components having dimension d.
 
int getCoordinateDimension () const override
 Returns coordinate dimension.
 
std::unique_ptr< GeometrygetBoundary () const override
 Returns the boundary, or an empty geometry of appropriate dimension if this Geometry is empty. More...
 
int getBoundaryDimension () const override
 Returns the maximum boundary dimension of geometries in this collection.
 
std::size_t getNumPoints () const override
 Returns the count of this Geometrys vertices.
 
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.
 
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_ro (CoordinateFilter *filter) const override
 
void apply_rw (const CoordinateFilter *filter) override
 
void apply_ro (GeometryFilter *filter) const override
 
void apply_rw (GeometryFilter *filter) override
 
void apply_ro (GeometryComponentFilter *filter) const override
 
void apply_rw (GeometryComponentFilter *filter) override
 
void apply_rw (CoordinateSequenceFilter &filter) override
 
void apply_ro (CoordinateSequenceFilter &filter) const override
 
void normalize () override
 Converts this Geometry to normal form (or canonical form).
 
const CoordinategetCoordinate () const override
 Returns a vertex of this Geometry, or NULL if this is the empty geometry.
 
double getArea () const override
 Returns the total area of this collection.
 
double getLength () const override
 Returns the total length of this collection.
 
std::size_t getNumGeometries () const override
 Returns the number of geometries in this collection.
 
const GeometrygetGeometryN (std::size_t n) const override
 Returns a pointer to the nth Geometry in this collection.
 
std::unique_ptr< 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
 Returns the ID of the Spatial Reference System used by the Geometry. More...
 
const PrecisionModelgetPrecisionModel () const
 Get the PrecisionModel used to create this Geometry.
 
virtual bool isSimple () const
 Returns false if the Geometry not simple.
 
virtual bool isValid () const
 Tests the validity of this Geometry. More...
 
virtual bool isRectangle () const
 Polygon overrides to check for actual rectangle.
 
bool isPuntal () const
 
bool isLineal () const
 
bool isPolygonal () const
 
virtual std::unique_ptr< 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).
 
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
< IntersectionMatrix
relate (const Geometry *g) const
 Returns the DE-9IM intersection matrix for the two Geometrys.
 
std::unique_ptr
< IntersectionMatrix
relate (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
 
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.
 
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
 
virtual double distance (const Geometry *g) const
 Returns the minimum distance between this Geometry and the Geometry g.
 
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).
 
void geometryChangedAction ()
 Notifies this Geometry that its Coordinates have been changed by an external party.
 

Protected Member Functions

 GeometryCollection (const GeometryCollection &gc)
 
 GeometryCollection (std::vector< Geometry * > *newGeoms, const GeometryFactory *newFactory)
 Construct a GeometryCollection with the given GeometryFactory. Will keep a reference to the factory, so don't delete it until al Geometry objects referring to it are deleted. Will take ownership of the Geometry vector. More...
 
 GeometryCollection (std::vector< std::unique_ptr< Geometry >> &&newGeoms, const GeometryFactory &newFactory)
 
template<typename T >
 GeometryCollection (std::vector< std::unique_ptr< T >> &&newGeoms, const GeometryFactory &newFactory)
 Convenience constructor to build a GeometryCollection from vector of Geometry subclass pointers.
 
int getSortIndex () const override
 
Envelope::Ptr computeEnvelopeInternal () const override
 
int compareToSameClass (const Geometry *gc) 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
 
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

std::vector< std::unique_ptr
< Geometry > > 
geometries
 
- 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
template<typename T >
static bool hasNonEmptyElements (const std::vector< T > *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.
 
template<typename T >
static bool hasNullElements (const std::vector< T > *geometries)
 Returns true if the vector contains any null elements.
 
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

Represents a collection of heterogeneous Geometry objects.

Collections of Geometry of the same type are represented by GeometryCollection subclasses MultiPoint, MultiLineString, MultiPolygon.

Constructor & Destructor Documentation

geos::geom::GeometryCollection::GeometryCollection ( std::vector< Geometry * > *  newGeoms,
const GeometryFactory newFactory 
)
protected

Construct a GeometryCollection with the given GeometryFactory. Will keep a reference to the factory, so don't delete it until al Geometry objects referring to it are deleted. Will take ownership of the Geometry vector.

Parameters
newGeomsThe Geometrys for this GeometryCollection, or null or an empty array to create the empty geometry. Elements may be empty Geometrys, but not nulls.

If construction succeed the created object will take ownership of newGeoms vector and elements.

If construction fails "IllegalArgumentException *" is thrown and it is your responsibility to delete newGeoms vector and content.

Parameters
newFactorythe GeometryFactory used to create this geometry

Member Function Documentation

void geos::geom::GeometryCollection::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::GeometryCollection::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::GeometryCollection::clone ( ) const
inlineoverridevirtual

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

Returns
a clone of this instance

Implements geos::geom::Geometry.

Reimplemented in geos::geom::MultiPoint, geos::geom::MultiPolygon, and geos::geom::MultiLineString.

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

Returns the boundary, or an empty geometry of appropriate dimension if this Geometry is empty.

(In the case of zero-dimensional geometries, an empty GeometryCollection is returned.) For a discussion of this function, see the OpenGIS Simple Features Specification. As stated in SFS Section 2.1.13.1, "the boundary of a Geometry is a set of Geometries of the next lower dimension."

Returns
the closure of the combinatorial boundary of this Geometry. Ownershipof the returned object transferred to caller.

Implements geos::geom::Geometry.

Reimplemented in geos::geom::MultiPolygon, geos::geom::MultiPoint, and geos::geom::MultiLineString.

std::unique_ptr<CoordinateSequence> geos::geom::GeometryCollection::getCoordinates ( ) const
overridevirtual

Collects all coordinates of all subgeometries into a CoordinateSequence.

Note that the returned coordinates are copies, so you want be able to use them to modify the geometries in place. Also you'll need to delete the CoordinateSequence when finished using it.

Returns
the collected coordinates

Implements geos::geom::Geometry.

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

Returns the maximum dimension of geometries in this collection (0=point, 1=line, 2=surface)

See also
Dimension::DimensionType

Implements geos::geom::Geometry.

Reimplemented in geos::geom::MultiPolygon, geos::geom::MultiPoint, and geos::geom::MultiLineString.

std::unique_ptr<Geometry> geos::geom::GeometryCollection::reverse ( ) const
overridevirtual

Creates a GeometryCollection with every component reversed. The order of the components in the collection are not reversed.

Returns
a GeometryCollection in the reverse order

Implements geos::geom::Geometry.

Reimplemented in geos::geom::MultiPoint, geos::geom::MultiLineString, and geos::geom::MultiPolygon.


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