File: qgspointcloudattribute.sip.in

package info (click to toggle)
qgis 3.40.13%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 1,185,160 kB
  • sloc: cpp: 1,615,781; python: 372,865; xml: 23,474; sh: 3,761; perl: 3,664; ansic: 2,829; sql: 2,137; yacc: 1,068; lex: 577; javascript: 540; lisp: 411; makefile: 155
file content (180 lines) | stat: -rw-r--r-- 4,323 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/pointcloud/qgspointcloudattribute.h                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/






class QgsPointCloudAttribute
{
%Docstring(signature="appended")
Attribute for point cloud data pair of name and size in bytes

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgspointcloudattribute.h"
%End
  public:
    enum DataType
    {
      Char,
      UChar,
      Short,
      UShort,
      Int32,
      UInt32,
      Int64,
      UInt64,
      Float,
      Double,
    };

    QgsPointCloudAttribute();
    QgsPointCloudAttribute( const QString &name, DataType type );
%Docstring
Ctor
%End

    QString name() const;
%Docstring
Returns name of the attribute
%End

    int size() const;
%Docstring
Returns size of the attribute in bytes
%End

    DataType type() const;
%Docstring
Returns the data type

.. seealso:: :py:func:`variantType`
%End

    QMetaType::Type variantType() const;
%Docstring
Returns the most suitable equivalent QVariant data type to this
attribute type.

.. seealso:: :py:func:`type`
%End

    QString displayType() const;
%Docstring
Returns the type to use when displaying this field.

This will be used when the full datatype with details has to displayed
to the user.

.. seealso:: :py:func:`type`
%End


    static bool isNumeric( DataType type );
%Docstring
Returns ``True`` if the specified data ``type`` is numeric.
%End

    SIP_PYOBJECT __repr__();
%MethodCode
    QString str = QStringLiteral( "<QgsPointCloudAttribute: %1 (%2)>" ).arg( sipCpp->name() ).arg( sipCpp->displayType() );
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
%End



};

class QgsPointCloudAttributeCollection
{
%Docstring(signature="appended")
Collection of point cloud attributes

.. versionadded:: 3.18
%End

%TypeHeaderCode
#include "qgspointcloudattribute.h"
%End
  public:

    QgsPointCloudAttributeCollection();
    QgsPointCloudAttributeCollection( const QVector<QgsPointCloudAttribute> &attributes );
%Docstring
Ctor with given attributes
%End
    void push_back( const QgsPointCloudAttribute &attribute );
%Docstring
Adds extra attribute
%End

    void extend( const QgsPointCloudAttributeCollection &otherCollection, const QSet<QString> &matchingNames );
%Docstring
Adds specific missing attributes from another
QgsPointCloudAttributeCollection

:param otherCollection: a QgsPointCloudAttributeCollection with more
                        attributes
:param matchingNames: the names of the attributes to be added

.. versionadded:: 3.26
%End

    QVector<QgsPointCloudAttribute> attributes() const;
%Docstring
Returns all attributes
%End

    int count() const;
%Docstring
Returns the number of attributes present in the collection.
%End

    const QgsPointCloudAttribute &at( int index ) const;
%Docstring
Returns the attribute at the specified ``index``.
%End

    const QgsPointCloudAttribute *find( const QString &attributeName, int &offset ) const;
%Docstring
Finds the attribute with the name

Returns ``None`` if not found.
%End

    int indexOf( const QString &name ) const;
%Docstring
Returns the index of the attribute with the specified ``name``.

Returns -1 if a matching attribute was not found.
%End

    int pointRecordSize() const;
%Docstring
Returns total size of record
%End

    QgsFields toFields() const;
%Docstring
Converts the attribute collection to an equivalent :py:class:`QgsFields`
collection.
%End

};

/************************************************************************
 * This file has been generated automatically from                      *
 *                                                                      *
 * src/core/pointcloud/qgspointcloudattribute.h                         *
 *                                                                      *
 * Do not edit manually ! Edit header and run scripts/sipify.py again   *
 ************************************************************************/