OGRMultiLineString Class Reference

A collection of OGRLineString. More...

#include <ogr_geometry.h>

Inheritance diagram for OGRMultiLineString:

List of all members.

Public Member Functions
	OGRMultiLineString ()
	Create an empty multi line string collection.
	OGRMultiLineString (const OGRMultiLineString &other)
	Copy constructor.
OGRMultiLineString &	operator= (const OGRMultiLineString &other)
	Assignment operator.
virtual const char *	getGeometryName () const CPL_OVERRIDE
	Fetch WKT name for geometry type.
virtual OGRwkbGeometryType	getGeometryType () const CPL_OVERRIDE
	Fetch geometry type.
virtual OGRErr	exportToWkt (char **, OGRwkbVariant=wkbVariantOldOgc) const CPL_OVERRIDE
	Convert a geometry into well known text format.
virtual OGRBoolean	hasCurveGeometry (int bLookForNonLinear=FALSE) const CPL_OVERRIDE
	Returns if this geometry is or has curve geometry.
Static Public Member Functions
static OGRMultiCurve *	CastToMultiCurve (OGRMultiLineString *poMLS)
	Cast to multicurve.
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.

---

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:

poMLS

the 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:

ppszDstText	a text buffer is allocated by the program, and assigned to the passed pointer. After use, *ppszDstText should be freed with CPLFree().
eWkbVariant	the 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:

bLookForNonLinear

set 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 [protected, virtual]

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

Parameters:

eSubType

type 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:

• ogr_geometry.h
• ogrmultilinestring.cpp