QGIS API Documentation 3.99.0-Master (09f76ad7019)
Loading...
Searching...
No Matches
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
23#include <QString>
24
25using namespace Qt::StringLiterals;
26
27class QgsLineString;
28
34class CORE_EXPORT QgsMultiLineString: public QgsMultiCurve
35{
36 public:
37
42
50 QgsMultiLineString( const QList< QgsLineString > &linestrings ) SIP_HOLDGIL;
51
59 QgsMultiLineString( const QList< QgsLineString * > &linestrings SIP_TRANSFER ) SIP_HOLDGIL;
60
61#ifndef SIP_RUN
62
68 QgsLineString *lineStringN( int index );
69#else
70
78 SIP_PYOBJECT lineStringN( int index ) SIP_TYPEHINT( QgsLineString );
79 % MethodCode
80 if ( a0 < 0 || a0 >= sipCpp->numGeometries() )
81 {
82 PyErr_SetString( PyExc_IndexError, QByteArray::number( a0 ) );
83 sipIsErr = 1;
84 }
85 else
86 {
87 return sipConvertFromType( sipCpp->lineStringN( a0 ), sipType_QgsLineString, NULL );
88 }
89 % End
90#endif
91
92#ifndef SIP_RUN
93
101 const QgsLineString *lineStringN( int index ) const;
102#endif
103
104 QString geometryType() const override SIP_HOLDGIL;
105 QgsMultiLineString *clone() const override SIP_FACTORY;
106 void clear() override;
107 bool fromWkt( const QString &wkt ) override;
108 QDomElement asGml2( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
109 QDomElement asGml3( QDomDocument &doc, int precision = 17, const QString &ns = "gml", QgsAbstractGeometry::AxisOrder axisOrder = QgsAbstractGeometry::AxisOrder::XY ) const override;
110 json asJsonObject( int precision = 17 ) const override SIP_SKIP;
111 bool addGeometry( QgsAbstractGeometry *g SIP_TRANSFER ) override;
112 bool addGeometries( const QVector< QgsAbstractGeometry * > &geometries SIP_TRANSFER ) final;
113 bool insertGeometry( QgsAbstractGeometry *g SIP_TRANSFER, int index ) override;
114 QgsMultiLineString *simplifyByDistance( double tolerance ) const override SIP_FACTORY;
115
120 QgsMultiCurve *toCurveType() const override SIP_FACTORY;
121
122#ifndef SIP_RUN
123
132 inline static const QgsMultiLineString *cast( const QgsAbstractGeometry *geom ) // cppcheck-suppress duplInheritedMember
133 {
135 return static_cast<const QgsMultiLineString *>( geom );
136 return nullptr;
137 }
138
147 inline static QgsMultiLineString *cast( QgsAbstractGeometry *geom ) // cppcheck-suppress duplInheritedMember
148 {
150 return static_cast<QgsMultiLineString *>( geom );
151 return nullptr;
152 }
153#endif
154
156
157#ifdef SIP_RUN
158 SIP_PYOBJECT __repr__();
159 % MethodCode
160 QString wkt = sipCpp->asWkt();
161 if ( wkt.length() > 1000 )
162 wkt = wkt.left( 1000 ) + u"..."_s;
163 QString str = u"<QgsMultiLineString: %1>"_s.arg( wkt );
164 sipRes = PyUnicode_FromString( str.toUtf8().constData() );
165 % End
166#endif
167
174 QgsMultiLineString *measuredLine( double start, double end ) const SIP_FACTORY;
175
176 protected:
177
178 bool wktOmitChildType() const override;
179};
180
181// clazy:excludeall=qstring-allocations
182
183#endif // QGSMULTILINESTRING_H
@ MultiLineString
MultiLineString.
Definition qgis.h:287
AxisOrder
Axis order for GML generation.
@ XY
X comes before Y (or lon before lat).
Qgis::WkbType wkbType() const
Returns the WKB type of the geometry.
QgsAbstractGeometry()=default
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.
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 * simplifyByDistance(double tolerance) const override
Simplifies the geometry by applying the Douglas Peucker simplification by distance algorithm.
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 addGeometries(const QVector< QgsAbstractGeometry * > &geometries) override
Adds a list of geometries to the collection, transferring ownership to the collection.
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 QgsMultiLineString * cast(QgsAbstractGeometry *geom)
Cast the geom to a QgsMultiLineString.
QgsMultiLineString()
Constructor for an empty multilinestring geometry.
QgsLineString * lineStringN(int index)
Returns the line string with the specified index.
static Qgis::WkbType flatType(Qgis::WkbType type)
Returns the flat type for a WKB type.
#define SIP_TYPEHINT(type)
Definition qgis_sip.h:240
#define SIP_SKIP
Definition qgis_sip.h:134
#define SIP_TRANSFER
Definition qgis_sip.h:36
#define SIP_HOLDGIL
Definition qgis_sip.h:179
#define SIP_FACTORY
Definition qgis_sip.h:84