QGIS API Documentation 3.39.0-Master (8f4da32b6b8)
Loading...
Searching...
No Matches
qgsmaplayerdependency.h
Go to the documentation of this file.
1
2/***************************************************************************
3 qgsmaplayerdependency.h - description
4 -------------------
5 begin : September 2016
6 copyright : (C) 2016 by Hugo Mercier
7 email : hugo dot mercier at oslandia dot com
8 ***************************************************************************/
9
10/***************************************************************************
11 * *
12 * This program is free software; you can redistribute it and/or modify *
13 * it under the terms of the GNU General Public License as published by *
14 * the Free Software Foundation; either version 2 of the License, or *
15 * (at your option) any later version. *
16 * *
17 ***************************************************************************/
18
19#ifndef QGSMAPLAYERDEPENDENCY_H
20#define QGSMAPLAYERDEPENDENCY_H
21
22#include "qgis_core.h"
23#include <QString>
24
36class CORE_EXPORT QgsMapLayerDependency
37{
38 public:
40 enum Type
41 {
42 PresenceDependency = 1, //< The layer must be already present (in the registry) for this dependency to be resolved
43 DataDependency = 2 //< The layer may be invalidated by data changes on another layer
44 };
45
47 enum Origin
48 {
49 FromProvider = 0, //< Dependency given by the provider, the user cannot change it
50 FromUser = 1 //< Dependency given by the user
51 };
52
54 QgsMapLayerDependency( const QString &layerId, Type type = DataDependency, Origin origin = FromUser )
55 : mType( type )
56 , mOrigin( origin )
57 , mLayerId( layerId )
58 {}
59
61 Type type() const { return mType; }
62
64 Origin origin() const { return mOrigin; }
65
67 QString layerId() const { return mLayerId; }
68
69 // TODO c++20 - replace with = default
70
71 bool operator==( const QgsMapLayerDependency &other ) const
72 {
73 return layerId() == other.layerId() && origin() == other.origin() && type() == other.type();
74 }
75
76#ifdef SIP_RUN
78 long __hash__() const;
79 % MethodCode
80 sipRes = qHash( *sipCpp );
81 % End
82#endif
83 private:
84 Type mType;
85 Origin mOrigin;
86 QString mLayerId;
87};
88
89#ifndef SIP_RUN
90
94inline uint qHash( const QgsMapLayerDependency &dep )
95{
96 return qHash( dep.layerId() ) + dep.origin() + dep.type();
97}
98#endif
99
100#endif
This class models dependencies with or between map layers.
QgsMapLayerDependency(const QString &layerId, Type type=DataDependency, Origin origin=FromUser)
Standard constructor.
Origin
Origin of the dependency.
bool operator==(const QgsMapLayerDependency &other) const
QString layerId() const
Returns the ID of the layer this dependency depends on.
Origin origin() const
Returns the dependency origin.
Type type() const
Returns the dependency type.
uint qHash(const QVariant &variant)
Hash for QVariant.
Definition qgis.cpp:198
uint qHash(const QgsMapLayerDependency &dep)
global qHash function for QgsMapLayerDependency, so that it can be used in a QSet