QGIS API Documentation  2.12.0-Lyon
Classes | Public Types | Static Public Member Functions | List of all members
QgsWKBTypes Class Reference

Class to store information about wkb types. More...

#include <qgswkbtypes.h>

Classes

struct  wkbEntry
 

Public Types

enum  GeometryType {
  PointGeometry, LineGeometry, PolygonGeometry, UnknownGeometry,
  NullGeometry
}
 
enum  Type {
  Unknown = 0, Point = 1, LineString = 2, Polygon = 3,
  MultiPoint = 4, MultiLineString = 5, MultiPolygon = 6, GeometryCollection = 7,
  CircularString = 8, CompoundCurve = 9, CurvePolygon = 10, MultiCurve = 11,
  MultiSurface = 12, NoGeometry = 100, PointZ = 1001, LineStringZ = 1002,
  PolygonZ = 1003, MultiPointZ = 1004, MultiLineStringZ = 1005, MultiPolygonZ = 1006,
  GeometryCollectionZ = 1007, CircularStringZ = 1008, CompoundCurveZ = 1009, CurvePolygonZ = 1010,
  MultiCurveZ = 1011, MultiSurfaceZ = 1012, PointM = 2001, LineStringM = 2002,
  PolygonM = 2003, MultiPointM = 2004, MultiLineStringM = 2005, MultiPolygonM = 2006,
  GeometryCollectionM = 2007, CircularStringM = 2008, CompoundCurveM = 2009, CurvePolygonM = 2010,
  MultiCurveM = 2011, MultiSurfaceM = 2012, PointZM = 3001, LineStringZM = 3002,
  PolygonZM = 3003, MultiPointZM = 3004, MultiLineStringZM = 3005, MultiPolygonZM = 3006,
  GeometryCollectionZM = 3007, CircularStringZM = 3008, CompoundCurveZM = 3009, CurvePolygonZM = 3010,
  MultiCurveZM = 3011, MultiSurfaceZM = 3012, Point25D = 0x80000001, LineString25D,
  Polygon25D, MultiPoint25D, MultiLineString25D, MultiPolygon25D
}
 

Static Public Member Functions

static Type addM (Type type)
 Adds the m dimension to a WKB type and returns the new type. More...
 
static Type addZ (Type type)
 Adds the z dimension to a WKB type and returns the new type. More...
 
static QString displayString (Type type)
 
static Type flatType (Type type)
 
static GeometryType geometryType (Type type)
 
static bool hasM (Type type)
 Tests whether a WKB type contains m values. More...
 
static bool hasZ (Type type)
 Tests whether a WKB type contains the z-dimension. More...
 
static bool isMultiType (Type type)
 
static bool isSingleType (Type type)
 
static Type multiType (Type type)
 
static Type parseType (const QString &wktStr)
 
static Type singleType (Type type)
 
static int wkbDimensions (Type type)
 

Detailed Description

Class to store information about wkb types.

Definition at line 25 of file qgswkbtypes.h.

Member Enumeration Documentation

Enumerator
PointGeometry 
LineGeometry 
PolygonGeometry 
UnknownGeometry 
NullGeometry 

Definition at line 89 of file qgswkbtypes.h.

Enumerator
Unknown 
Point 
LineString 
Polygon 
MultiPoint 
MultiLineString 
MultiPolygon 
GeometryCollection 
CircularString 
CompoundCurve 
CurvePolygon 
MultiCurve 
MultiSurface 
NoGeometry 
PointZ 
LineStringZ 
PolygonZ 
MultiPointZ 
MultiLineStringZ 
MultiPolygonZ 
GeometryCollectionZ 
CircularStringZ 
CompoundCurveZ 
CurvePolygonZ 
MultiCurveZ 
MultiSurfaceZ 
PointM 
LineStringM 
PolygonM 
MultiPointM 
MultiLineStringM 
MultiPolygonM 
GeometryCollectionM 
CircularStringM 
CompoundCurveM 
CurvePolygonM 
MultiCurveM 
MultiSurfaceM 
PointZM 
LineStringZM 
PolygonZM 
MultiPointZM 
MultiLineStringZM 
MultiPolygonZM 
GeometryCollectionZM 
CircularStringZM 
CompoundCurveZM 
CurvePolygonZM 
MultiCurveZM 
MultiSurfaceZM 
Point25D 
LineString25D 
Polygon25D 
MultiPoint25D 
MultiLineString25D 
MultiPolygon25D 

Definition at line 29 of file qgswkbtypes.h.

Member Function Documentation

QgsWKBTypes::Type QgsWKBTypes::addM ( QgsWKBTypes::Type  type)
static

Adds the m dimension to a WKB type and returns the new type.

Parameters
typeoriginal type
Note
added in QGIS 2.12
See also
addZ()
hasM()

Definition at line 156 of file qgswkbtypes.cpp.

QgsWKBTypes::Type QgsWKBTypes::addZ ( QgsWKBTypes::Type  type)
static

Adds the z dimension to a WKB type and returns the new type.

Parameters
typeoriginal type
Note
added in QGIS 2.12
See also
addM()
hasZ()

Definition at line 139 of file qgswkbtypes.cpp.

QString QgsWKBTypes::displayString ( Type  type)
static

Definition at line 109 of file qgswkbtypes.cpp.

QgsWKBTypes::Type QgsWKBTypes::flatType ( Type  type)
static

Definition at line 46 of file qgswkbtypes.cpp.

QgsWKBTypes::GeometryType QgsWKBTypes::geometryType ( Type  type)
static

Definition at line 99 of file qgswkbtypes.cpp.

bool QgsWKBTypes::hasM ( Type  type)
static

Tests whether a WKB type contains m values.

Returns
true if type has m values
See also
addM()
hasZ()

Definition at line 129 of file qgswkbtypes.cpp.

bool QgsWKBTypes::hasZ ( Type  type)
static

Tests whether a WKB type contains the z-dimension.

Returns
true if type has z values
See also
addZ()
hasM()

Definition at line 119 of file qgswkbtypes.cpp.

bool QgsWKBTypes::isMultiType ( Type  type)
static

Definition at line 75 of file qgswkbtypes.cpp.

bool QgsWKBTypes::isSingleType ( Type  type)
static

Definition at line 70 of file qgswkbtypes.cpp.

QgsWKBTypes::Type QgsWKBTypes::multiType ( Type  type)
static

Definition at line 36 of file qgswkbtypes.cpp.

QgsWKBTypes::Type QgsWKBTypes::parseType ( const QString wktStr)
static

Definition at line 56 of file qgswkbtypes.cpp.

QgsWKBTypes::Type QgsWKBTypes::singleType ( Type  type)
static

Definition at line 26 of file qgswkbtypes.cpp.

int QgsWKBTypes::wkbDimensions ( Type  type)
static

Definition at line 85 of file qgswkbtypes.cpp.


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