QGIS API Documentation
4.3.0-Master (16eddb2670e)
Toggle main menu visibility
Loading...
Searching...
No Matches
src
core
providers
sensorthings
qgssensorthingsconnection.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgssensorthingsconnection.h
3
---------------------
4
Date : December 2023
5
Copyright : (C) 2023 by Nyall Dawson
6
Email : nyall dot dawson at gmail 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 QGSSENSORTHINGSCONNECTION_H
17
#define QGSSENSORTHINGSCONNECTION_H
18
19
20
#include "qgis_core.h"
21
#include "
qgsabstractproviderconnection.h
"
22
#include "
qgshttpheaders.h
"
23
#include "
qgssettingstree.h
"
24
25
#include <QString>
26
#include <QStringList>
27
28
#define SIP_NO_FILE
29
30
using namespace
Qt::StringLiterals;
31
32
class
QgsSettingsEntryBool
;
33
class
QgsSettingsEntryDouble
;
34
class
QgsSettingsEntryInteger
;
35
class
QgsSettingsEntryString
;
36
class
QgsSettingsEntryVariantMap
;
37
template
<
class
T>
class
QgsSettingsEntryEnumFlag
;
38
47
class
CORE_EXPORT
QgsSensorThingsProviderConnection
:
public
QgsAbstractProviderConnection
48
{
49
public
:
51
static
inline
QgsSettingsTreeNamedListNode
*sTreeSensorThingsConnections
52
=
QgsSettingsTree::sTreeConnections
->createNamedListNode( u
"sensorthings"
_s,
Qgis::SettingsTreeNodeOption::NamedListSelectedItemSetting
);
53
54
static
const
QgsSettingsEntryString
*settingsUrl;
55
static
const
QgsSettingsEntryVariantMap
*settingsHeaders;
56
static
const
QgsSettingsEntryString
*settingsUsername;
57
static
const
QgsSettingsEntryString
*settingsPassword;
58
static
const
QgsSettingsEntryString
*settingsAuthcfg;
60
64
QgsSensorThingsProviderConnection
(
const
QString &name );
65
69
QgsSensorThingsProviderConnection
(
const
QString &
uri
,
const
QVariantMap &
configuration
);
70
71
void
store
(
const
QString &name )
const
final
;
72
void
remove
(
const
QString &name )
const
final
;
73
82
struct
Data
83
{
85
QString
url
;
87
QString
authCfg
;
89
QString
username
;
91
QString
password
;
93
QgsHttpHeaders
httpHeaders
;
94
};
95
102
static
QString
encodedUri
(
const
Data
&data );
103
110
static
Data
decodedUri
(
const
QString &
uri
);
111
118
static
QString
encodedLayerUri
(
const
Data
&data );
119
123
static
QStringList
connectionList
();
124
128
static
Data
connection
(
const
QString &name );
129
133
static
void
addConnection
(
const
QString &name,
const
Data
&
connection
);
134
140
static
QString
selectedConnection
();
141
147
static
void
setSelectedConnection
(
const
QString &name );
148
};
149
150
151
#endif
// QGSSENSORTHINGSCONNECTION_H
Qgis::SettingsTreeNodeOption::NamedListSelectedItemSetting
@ NamedListSelectedItemSetting
Creates a setting to store which is the current item.
Definition
qgis.h:728
QgsAbstractProviderConnection::configuration
QVariantMap configuration() const
Returns the connection configuration parameters.
Definition
qgsabstractproviderconnection.cpp:47
QgsAbstractProviderConnection::QgsAbstractProviderConnection
QgsAbstractProviderConnection(const QString &name)
Creates a new connection with name by reading its configuration from the settings.
Definition
qgsabstractproviderconnection.cpp:20
QgsAbstractProviderConnection::remove
virtual void remove(const QString &name) const =0
Deletes the connection from the settings.
QgsAbstractProviderConnection::store
virtual void store(const QString &name) const =0
Stores the connection in the settings.
QgsAbstractProviderConnection::uri
QString uri() const
Returns the connection data source URI string representation.
Definition
qgsabstractproviderconnection.cpp:37
QgsHttpHeaders
Implements simple HTTP header management.
Definition
qgshttpheaders.h:41
QgsSensorThingsProviderConnection::selectedConnection
static QString selectedConnection()
Returns the name of the last used connection.
Definition
qgssensorthingsconnection.cpp:58
QgsSensorThingsProviderConnection::encodedUri
static QString encodedUri(const Data &data)
Returns connection data encoded as a string.
Definition
qgssensorthingsconnection.cpp:99
QgsSensorThingsProviderConnection::encodedLayerUri
static QString encodedLayerUri(const Data &data)
Returns connection data encoded as a string containing a URI for a SensorThings vector data provider.
Definition
qgssensorthingsconnection.cpp:130
QgsSensorThingsProviderConnection::setSelectedConnection
static void setSelectedConnection(const QString &name)
Stores the name of the last used connection.
Definition
qgssensorthingsconnection.cpp:63
QgsSensorThingsProviderConnection::connectionList
static QStringList connectionList()
Returns a list of the stored connection names.
Definition
qgssensorthingsconnection.cpp:94
QgsSensorThingsProviderConnection::connection
static Data connection(const QString &name)
Returns connection details for the stored connection with the specified name.
Definition
qgssensorthingsconnection.cpp:77
QgsSensorThingsProviderConnection::QgsSensorThingsProviderConnection
PRIVATE QgsSensorThingsProviderConnection(const QString &name)
Constructor for QgsSensorThingsProviderConnection, using the stored settings with the specified conne...
Definition
qgssensorthingsconnection.cpp:36
QgsSensorThingsProviderConnection::decodedUri
static Data decodedUri(const QString &uri)
Returns a connection uri decoded to a data structure.
Definition
qgssensorthingsconnection.cpp:115
QgsSensorThingsProviderConnection::addConnection
static void addConnection(const QString &name, const Data &connection)
Stores a new connection, under the specified connection name.
Definition
qgssensorthingsconnection.cpp:68
QgsSettingsEntryBool
A boolean settings entry.
Definition
qgssettingsentryimpl.h:298
QgsSettingsEntryDouble
A double settings entry.
Definition
qgssettingsentryimpl.h:557
QgsSettingsEntryEnumFlag
A template class for enum and flag settings entry.
Definition
qgssettingsentryenumflag.h:40
QgsSettingsEntryInteger
An integer settings entry.
Definition
qgssettingsentryimpl.h:367
QgsSettingsEntryString
A string settings entry.
Definition
qgssettingsentryimpl.h:123
QgsSettingsEntryVariantMap
A string list settings entry.
Definition
qgssettingsentryimpl.h:789
QgsSettingsTreeNamedListNode
A named list tree node for the settings tree to help organizing and introspecting the tree.
Definition
qgssettingstreenode.h:201
QgsSettingsTree::sTreeConnections
static QgsSettingsTreeNode * sTreeConnections
Definition
qgssettingstree.h:50
qgsabstractproviderconnection.h
qgshttpheaders.h
qgssettingstree.h
QgsSensorThingsProviderConnection::Data
Represents decoded data of a SensorThings connection.
Definition
qgssensorthingsconnection.h:83
QgsSensorThingsProviderConnection::Data::password
QString password
HTTP Basic password.
Definition
qgssensorthingsconnection.h:91
QgsSensorThingsProviderConnection::Data::url
QString url
Source URI.
Definition
qgssensorthingsconnection.h:85
QgsSensorThingsProviderConnection::Data::username
QString username
HTTP Basic username.
Definition
qgssensorthingsconnection.h:89
QgsSensorThingsProviderConnection::Data::httpHeaders
QgsHttpHeaders httpHeaders
HTTP headers.
Definition
qgssensorthingsconnection.h:93
QgsSensorThingsProviderConnection::Data::authCfg
QString authCfg
Authentication configuration id.
Definition
qgssensorthingsconnection.h:87
Generated on
for QGIS API Documentation by
1.17.0