QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsmultilinestring.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmultilinestring.h
3 -------------------------------------------------------------------
4Date : 28 Oct 2014
5Copyright : (C) 2014 by Marco Hugentobler
6email : marco.hugentobler at sourcepole dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSMULTILINESTRING_H
17#define QGSMULTILINESTRING_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
21#include "qgsmulticurve.h"
22
23class QgsLineString;
24
30class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve
31{
32 public:
33
38
39
40#ifndef SIP_RUN
41
47 QgsLineString *lineStringN( int index );
48#else
49
57 SIP_PYOBJECT lineStringN( int index ) SIP_TYPEHINT( QgsLineString );
58 % MethodCode
59 if ( a0 < 0 || a0 >= sipCpp->numGeometries() )
60 {
61 PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
62 sipIsErr = 1;
63 }
64 else
65 {
66 return sipConvertFromType( sipCpp->lineStringN( a0 ), sipType_QgsLineString, NULL );
67 }
68 % End
69#endif
70
71#ifndef SIP_RUN
72
80 const QgsLineString *lineStringN( int index ) const;
81#endif
82
83 QString geometryType() const override SIP_HOLDGIL;
84 QgsMultiLineString *clone() const override SIP_FACTORY;
85 void clear() override;
86 bool fromWkt( const QString &wkt ) override;
87 QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
88 QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
89 json asJsonObject( int precision = 17 ) const override SIP_SKIP;
91 bool insertGeometry( QgsAbstractGeometry *g SIP_TRANSFER, int index ) override;
92
97 QgsMultiCurve *toCurveType() const override SIP_FACTORY;
98
99#ifndef SIP_RUN
100
107 inline static const QgsMultiLineString *cast( const QgsAbstractGeometry *geom )
108 {
110 return static_cast<const QgsMultiLineString *>( geom );
111 return nullptr;
112 }
113#endif
114
116
117#ifdef SIP_RUN
118 SIP_PYOBJECT __repr__();
119 % MethodCode
120 QString wkt = sipCpp->asWkt();
121 if ( wkt.length() > 1000 )
122 wkt = wkt.left( 1000 ) + QStringLiteral( "..." );
123 QString str = QStringLiteral( "<QgsMultiLineString: %1>" ).arg( wkt );
124 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
125 % End
126#endif
127
134 QgsMultiLineString *measuredLine( double start, double end ) const SIP_FACTORY;
135
136 protected:
137
138 bool wktOmitChildType() const override;
139};
140
141// clazy:excludeall=qstring-allocations
142
143#endif // QGSMULTILINESTRING_H
@ MultiLineString
MultiLineString.
Abstract base class for all geometries.
AxisOrder
Axis order for GML generation.
Qgis::WkbType wkbType() const
Returns the WKB type of the geometry.
virtual bool wktOmitChildType() const
Returns whether child type names are omitted from Wkt representations of the collection.
Line string geometry type, with support for z-dimension and m-values.
Definition: qgslinestring.h:45
Multi curve geometry collection.
Definition: qgsmulticurve.h:29
QString geometryType() const override
Returns a unique string representing the geometry type.
json asJsonObject(int precision=17) const override
Returns a json object representation of the geometry.
QgsMultiCurve * toCurveType() const override
Returns the geometry converted to the more generic curve type.
QDomElement asGml2(QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override
Returns a GML2 representation of the geometry.
bool insertGeometry(QgsAbstractGeometry *g, int index) override
Inserts a geometry before a specified index and takes ownership.
QDomElement asGml3(QDomDocument &doc, int precision=17, const QString &ns="gml", QgsAbstractGeometry::AxisOrder axisOrder=QgsAbstractGeometry::AxisOrder::XY) const override
Returns a GML3 representation of the geometry.
QgsMultiCurve * createEmptyWithSameType() const override
Creates a new geometry with the same class and same WKB type as the original and transfers ownership.
bool addGeometry(QgsAbstractGeometry *g) override
Adds a geometry and takes ownership. Returns true in case of success.
bool fromWkt(const QString &wkt) override
Sets the geometry from a WKT string.
QgsMultiCurve * clone() const override
Clones the geometry by performing a deep copy.
void clear() override
Clears the geometry, ie reset it to a null geometry.
Multi line string geometry collection.
static const QgsMultiLineString * cast(const QgsAbstractGeometry *geom)
Cast the geom to a QgsMultiLineString.
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
Definition: qgswkbtypes.h:628
#define str(x)
Definition: qgis.cpp:38
#define SIP_TYPEHINT(type)
Definition: qgis_sip.h:232
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_TRANSFER
Definition: qgis_sip.h:36
#define SIP_HOLDGIL
Definition: qgis_sip.h:171
#define SIP_FACTORY
Definition: qgis_sip.h:76
int precision