GDAL
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OGRMultiLineString Class Reference

A collection of OGRLineString. More...

#include <ogr_geometry.h>

Inheritance diagram for OGRMultiLineString:
OGRMultiCurve OGRGeometryCollection OGRGeometry

Public Member Functions

 OGRMultiLineString ()
 Create an empty multi line string collection.
 
 OGRMultiLineString (const OGRMultiLineString &other)
 Copy constructor. More...
 
OGRMultiLineStringoperator= (const OGRMultiLineString &other)
 Assignment operator. More...
 
virtual const char * getGeometryName () const CPL_OVERRIDE
 Fetch WKT name for geometry type. More...
 
virtual OGRwkbGeometryType getGeometryType () const CPL_OVERRIDE
 Fetch geometry type. More...
 
virtual OGRErr exportToWkt (char **, OGRwkbVariant=wkbVariantOldOgc) const CPL_OVERRIDE
 Convert a geometry into well known text format. More...
 
virtual OGRBoolean hasCurveGeometry (int bLookForNonLinear=FALSE) const CPL_OVERRIDE
 Returns if this geometry is or has curve geometry. More...
 
- Public Member Functions inherited from OGRMultiCurve
 OGRMultiCurve ()
 Create an empty multi curve collection.
 
 OGRMultiCurve (const OGRMultiCurve &other)
 Copy constructor. More...
 
OGRMultiCurveoperator= (const OGRMultiCurve &other)
 Assignment operator. More...
 
virtual OGRErr importFromWkt (char **) CPL_OVERRIDE
 Assign geometry from well known text data. More...
 
virtual int getDimension () const CPL_OVERRIDE
 Get the dimension of this object. More...
 
- Public Member Functions inherited from OGRGeometryCollection
 OGRGeometryCollection ()
 Create an empty geometry collection.
 
 OGRGeometryCollection (const OGRGeometryCollection &other)
 Copy constructor. More...
 
OGRGeometryCollectionoperator= (const OGRGeometryCollection &other)
 Assignment operator. More...
 
virtual OGRGeometryclone () const CPL_OVERRIDE
 Make a copy of this object. More...
 
virtual void empty () CPL_OVERRIDE
 Clear geometry information. More...
 
virtual OGRErr transform (OGRCoordinateTransformation *poCT) CPL_OVERRIDE
 Apply arbitrary coordinate transformation to geometry. More...
 
virtual void flattenTo2D () CPL_OVERRIDE
 Convert geometry to strictly 2D. More...
 
virtual OGRBoolean IsEmpty () const CPL_OVERRIDE
 Returns TRUE (non-zero) if the object has no points. More...
 
virtual void segmentize (double dfMaxLength) CPL_OVERRIDE
 Modify the geometry such it has no segment longer then the given distance. More...
 
virtual OGRGeometrygetCurveGeometry (const char *const *papszOptions=NULL) const CPL_OVERRIDE
 Return curve version of this geometry. More...
 
virtual OGRGeometrygetLinearGeometry (double dfMaxAngleStepSizeDegrees=0, const char *const *papszOptions=NULL) const CPL_OVERRIDE
 Return, possibly approximate, non-curve version of this geometry. More...
 
virtual int WkbSize () const CPL_OVERRIDE
 Returns size of related binary representation. More...
 
virtual OGRErr importFromWkb (unsigned char *, int=-1, OGRwkbVariant=wkbVariantOldOgc) CPL_OVERRIDE
 Assign geometry from well known binary data. More...
 
virtual OGRErr exportToWkb (OGRwkbByteOrder, unsigned char *, OGRwkbVariant=wkbVariantOldOgc) const CPL_OVERRIDE
 Convert a geometry into well known binary format. More...
 
virtual double get_Length () const
 Compute the length of a multicurve. More...
 
virtual double get_Area () const
 Compute area of geometry collection. More...
 
virtual void getEnvelope (OGREnvelope *psEnvelope) const CPL_OVERRIDE
 Computes and returns the bounding envelope for this geometry in the passed psEnvelope structure. More...
 
virtual void getEnvelope (OGREnvelope3D *psEnvelope) const CPL_OVERRIDE
 Computes and returns the bounding envelope (3D) for this geometry in the passed psEnvelope structure. More...
 
int getNumGeometries () const
 Fetch number of geometries in container. More...
 
OGRGeometrygetGeometryRef (int)
 Fetch geometry from container. More...
 
const OGRGeometrygetGeometryRef (int) const
 Fetch geometry from container. More...
 
virtual OGRBoolean Equals (OGRGeometry *) const CPL_OVERRIDE
 Returns TRUE if two geometries are equivalent. More...
 
virtual void setCoordinateDimension (int nDimension) CPL_OVERRIDE
 Set the coordinate dimension. More...
 
virtual void set3D (OGRBoolean bIs3D) CPL_OVERRIDE
 Add or remove the Z coordinate dimension. More...
 
virtual void setMeasured (OGRBoolean bIsMeasured) CPL_OVERRIDE
 Add or remove the M coordinate dimension. More...
 
virtual OGRErr addGeometry (const OGRGeometry *)
 Add a geometry to the container. More...
 
virtual OGRErr addGeometryDirectly (OGRGeometry *)
 Add a geometry directly to the container. More...
 
virtual OGRErr removeGeometry (int iIndex, int bDelete=TRUE)
 Remove a geometry from the container. More...
 
void closeRings () CPL_OVERRIDE
 Force rings to be closed. More...
 
virtual void swapXY () CPL_OVERRIDE
 Swap x and y coordinates. More...
 
- Public Member Functions inherited from OGRGeometry
 OGRGeometry (const OGRGeometry &other)
 Copy constructor. More...
 
OGRGeometryoperator= (const OGRGeometry &other)
 Assignment operator. More...
 
virtual int getCoordinateDimension () const
 Get the dimension of the coordinates in this object. More...
 
int CoordinateDimension () const
 Get the dimension of the coordinates in this object. More...
 
virtual OGRBoolean IsValid () const
 Test if the geometry is valid. More...
 
virtual OGRBoolean IsSimple () const
 Test if the geometry is simple. More...
 
OGRBoolean Is3D () const
 
OGRBoolean IsMeasured () const
 
virtual OGRBoolean IsRing () const
 Test if the geometry is a ring. More...
 
OGRwkbGeometryType getIsoGeometryType () const
 Get the geometry type that conforms with ISO SQL/MM Part3. More...
 
virtual void dumpReadable (FILE *, const char *=NULL, char **papszOptions=NULL) const
 Dump geometry in well known text format to indicated output file. More...
 
virtual char * exportToGML (const char *const *papszOptions=NULL) const
 Convert a geometry into GML format. More...
 
virtual char * exportToKML () const
 Convert a geometry into KML format. More...
 
virtual char * exportToJson () const
 Convert a geometry into GeoJSON format. More...
 
virtual GEOSGeom exportToGEOS (GEOSContextHandle_t hGEOSCtxt) const CPL_WARN_UNUSED_RESULT
 Returns a GEOSGeom object corresponding to the geometry. More...
 
void assignSpatialReference (OGRSpatialReference *poSR)
 Assign spatial reference to this object. More...
 
OGRSpatialReferencegetSpatialReference (void) const
 Returns spatial reference system for object. More...
 
OGRErr transformTo (OGRSpatialReference *poSR)
 Transform geometry to new spatial reference system. More...
 
virtual OGRBoolean Intersects (const OGRGeometry *) const
 Do these features intersect? More...
 
virtual OGRBoolean Disjoint (const OGRGeometry *) const
 Test for disjointness. More...
 
virtual OGRBoolean Touches (const OGRGeometry *) const
 Test for touching. More...
 
virtual OGRBoolean Crosses (const OGRGeometry *) const
 Test for crossing. More...
 
virtual OGRBoolean Within (const OGRGeometry *) const
 Test for containment. More...
 
virtual OGRBoolean Contains (const OGRGeometry *) const
 Test for containment. More...
 
virtual OGRBoolean Overlaps (const OGRGeometry *) const
 Test for overlap. More...
 
virtual OGRGeometryBoundary () const CPL_WARN_UNUSED_RESULT
 Compute boundary. More...
 
virtual double Distance (const OGRGeometry *) const
 Compute distance between two geometries. More...
 
virtual OGRGeometryConvexHull () const CPL_WARN_UNUSED_RESULT
 Compute convex hull. More...
 
virtual OGRGeometryBuffer (double dfDist, int nQuadSegs=30) const CPL_WARN_UNUSED_RESULT
 Compute buffer of geometry. More...
 
virtual OGRGeometryIntersection (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute intersection. More...
 
virtual OGRGeometryUnion (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute union. More...
 
virtual OGRGeometryUnionCascaded () const CPL_WARN_UNUSED_RESULT
 Compute union using cascading. More...
 
virtual OGRGeometryDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute difference. More...
 
virtual OGRGeometrySymDifference (const OGRGeometry *) const CPL_WARN_UNUSED_RESULT
 Compute symmetric difference. More...
 
virtual OGRErr Centroid (OGRPoint *poPoint) const
 Compute the geometry centroid. More...
 
virtual OGRGeometrySimplify (double dTolerance) const CPL_WARN_UNUSED_RESULT
 Simplify the geometry. More...
 
OGRGeometrySimplifyPreserveTopology (double dTolerance) const CPL_WARN_UNUSED_RESULT
 Simplify the geometry while preserving topology. More...
 
virtual OGRGeometryDelaunayTriangulation (double dfTolerance, int bOnlyEdges) const CPL_WARN_UNUSED_RESULT
 Return a Delaunay triangulation of the vertices of the geometry. More...
 
virtual OGRGeometryPolygonize () const CPL_WARN_UNUSED_RESULT
 Polygonizes a set of sparse edges. More...
 
virtual double Distance3D (const OGRGeometry *poOtherGeom) const
 Returns the 3D distance between two geometries. More...
 

Static Public Member Functions

static OGRMultiCurveCastToMultiCurve (OGRMultiLineString *poMLS)
 Cast to multicurve. More...
 
- Static Public Member Functions inherited from OGRMultiCurve
static OGRMultiLineStringCastToMultiLineString (OGRMultiCurve *poMC)
 Cast to multi line string. More...
 
- Static Public Member Functions inherited from OGRGeometryCollection
static OGRGeometryCollectionCastToGeometryCollection (OGRGeometryCollection *poSrc)
 Cast to geometry collection. More...
 
- Static Public Member Functions inherited from OGRGeometry
static GEOSContextHandle_t createGEOSContext ()
 Create a new GEOS context. More...
 
static void freeGEOSContext (GEOSContextHandle_t hGEOSCtxt)
 Destroy a GEOS context. More...
 

Protected Member Functions

virtual OGRBoolean isCompatibleSubType (OGRwkbGeometryType) const CPL_OVERRIDE
 Returns whether a geometry of the specified geometry type can be a member of this collection. More...
 

Detailed Description

A collection of OGRLineString.

Constructor & Destructor Documentation

OGRMultiLineString::OGRMultiLineString ( const OGRMultiLineString other)

Copy constructor.

Note: before GDAL 2.1, only the default implementation of the constructor existed, which could be unsafe to use.

Since
GDAL 2.1

Member Function Documentation

OGRMultiCurve * OGRMultiLineString::CastToMultiCurve ( OGRMultiLineString poMLS)
static

Cast to multicurve.

The passed in geometry is consumed and a new one returned.

Parameters
poMLSthe input geometry - ownership is passed to the method.
Returns
new geometry.
OGRErr OGRMultiLineString::exportToWkt ( char **  ppszDstText,
OGRwkbVariant  eWkbVariant = wkbVariantOldOgc 
) const
virtual

Convert a geometry into well known text format.

This method relates to the SFCOM IWks::ExportToWKT() method.

This method is the same as the C function OGR_G_ExportToWkt().

Parameters
ppszDstTexta text buffer is allocated by the program, and assigned to the passed pointer. After use, *ppszDstText should be freed with CPLFree().
eWkbVariantthe specification that must be conformed too :
  • wbkVariantOgc for old-style 99-402 extended dimension (Z) WKB types
  • wbkVariantIso for SFSQL 1.2 and ISO SQL/MM Part 3
Returns
Currently OGRERR_NONE is always returned.

Reimplemented from OGRMultiCurve.

const char * OGRMultiLineString::getGeometryName ( ) const
virtual

Fetch WKT name for geometry type.

There is no SFCOM analog to this method.

This method is the same as the C function OGR_G_GetGeometryName().

Returns
name used for this geometry type in well known text format. The returned pointer is to a static internal string and should not be modified or freed.

Reimplemented from OGRMultiCurve.

OGRwkbGeometryType OGRMultiLineString::getGeometryType ( ) const
virtual

Fetch geometry type.

Note that the geometry type may include the 2.5D flag. To get a 2D flattened version of the geometry type apply the wkbFlatten() macro to the return result.

This method is the same as the C function OGR_G_GetGeometryType().

Returns
the geometry type code.

Reimplemented from OGRMultiCurve.

OGRBoolean OGRMultiLineString::hasCurveGeometry ( int  bLookForNonLinear = FALSE) const
virtual

Returns if this geometry is or has curve geometry.

Returns if a geometry is, contains or may contain a CIRCULARSTRING, COMPOUNDCURVE, CURVEPOLYGON, MULTICURVE or MULTISURFACE.

If bLookForNonLinear is set to TRUE, it will be actually looked if the geometry or its subgeometries are or contain a non-linear geometry in them. In which case, if the method returns TRUE, it means that getLinearGeometry() would return an approximate version of the geometry. Otherwise, getLinearGeometry() would do a conversion, but with just converting container type, like COMPOUNDCURVE -> LINESTRING, MULTICURVE -> MULTILINESTRING or MULTISURFACE -> MULTIPOLYGON, resulting in a "loss-less" conversion.

This method is the same as the C function OGR_G_HasCurveGeometry().

Parameters
bLookForNonLinearset it to TRUE to check if the geometry is or contains a CIRCULARSTRING.
Returns
TRUE if this geometry is or has curve geometry.
Since
GDAL 2.0

Reimplemented from OGRMultiCurve.

OGRBoolean OGRMultiLineString::isCompatibleSubType ( OGRwkbGeometryType  eSubType) const
protectedvirtual

Returns whether a geometry of the specified geometry type can be a member of this collection.

Parameters
eSubTypetype of the potential member
Returns
TRUE or FALSE

Reimplemented from OGRMultiCurve.

OGRMultiLineString & OGRMultiLineString::operator= ( const OGRMultiLineString other)

Assignment operator.

Note: before GDAL 2.1, only the default implementation of the operator existed, which could be unsafe to use.

Since
GDAL 2.1

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

Generated for GDAL by doxygen 1.8.8.