GDAL
Public Member Functions | Protected Member Functions
OGRMultiPoint Class Reference

A collection of OGRPoint. More...

#include <ogr_geometry.h>

Inheritance diagram for OGRMultiPoint:
OGRGeometryCollection OGRGeometry

List of all members.

Public Member Functions

 OGRMultiPoint ()
 Create an empty multi point collection.
virtual const char * getGeometryName () const
 Fetch WKT name for geometry type.
virtual OGRwkbGeometryType getGeometryType () const
 Fetch geometry type.
virtual OGRErr importFromWkt (char **)
 Assign geometry from well known text data.
virtual OGRErr exportToWkt (char **, OGRwkbVariant=wkbVariantOldOgc) const
 Convert a geometry into well known text format.
virtual int getDimension () const
 Get the dimension of this object.
virtual OGRBoolean hasCurveGeometry (int bLookForNonLinear=FALSE) const
 Returns if this geometry is or has curve geometry.

Protected Member Functions

virtual OGRBoolean isCompatibleSubType (OGRwkbGeometryType) const

Detailed Description

A collection of OGRPoint.


Member Function Documentation

OGRErr OGRMultiPoint::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 OGRFree().
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 OGRGeometryCollection.

int OGRMultiPoint::getDimension ( ) const [virtual]

Get the dimension of this object.

This method corresponds to the SFCOM IGeometry::GetDimension() method. It indicates the dimension of the object, but does not indicate the dimension of the underlying space (as indicated by OGRGeometry::getCoordinateDimension()).

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

Returns:
0 for points, 1 for lines and 2 for surfaces.

Reimplemented from OGRGeometryCollection.

const char * OGRMultiPoint::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 OGRGeometryCollection.

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 OGRGeometryCollection.

OGRBoolean OGRMultiPoint::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 OGRGeometryCollection.

OGRErr OGRMultiPoint::importFromWkt ( char **  ppszInput) [virtual]

Assign geometry from well known text data.

The object must have already been instantiated as the correct derived type of geometry object to match the text type. This method is used by the OGRGeometryFactory class, but not normally called by application code.

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

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

Parameters:
ppszInputpointer to a pointer to the source text. The pointer is updated to pointer after the consumed text.
Returns:
OGRERR_NONE if all goes well, otherwise any of OGRERR_NOT_ENOUGH_DATA, OGRERR_UNSUPPORTED_GEOMETRY_TYPE, or OGRERR_CORRUPT_DATA may be returned.

Reimplemented from OGRGeometryCollection.


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

Generated for GDAL by doxygen 1.7.6.1.