QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
qgsmeshlayertemporalproperties.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsmeshlayertemporalproperties.cpp
3 -----------------------
4 begin : March 2020
5 copyright : (C) 2020 by Vincent Cloarec
6 email : vcloarec at gmail dot com
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
20#include "qgsproject.h"
22
24 QgsMapLayerTemporalProperties( parent, enabled )
25{}
26
27QDomElement QgsMeshLayerTemporalProperties::writeXml( QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context )
28{
29 Q_UNUSED( context );
30
31 QDomElement temporalElement = doc.createElement( QStringLiteral( "temporal" ) );
32 temporalElement.setAttribute( QStringLiteral( "temporal-active" ), isActive() ? true : false );
33 temporalElement.setAttribute( QStringLiteral( "reference-time" ), mReferenceTime.toTimeSpec( Qt::UTC ).toString( Qt::ISODate ) );
34 temporalElement.setAttribute( QStringLiteral( "start-time-extent" ), mTimeExtent.begin().toTimeSpec( Qt::UTC ).toString( Qt::ISODate ) );
35 temporalElement.setAttribute( QStringLiteral( "end-time-extent" ), mTimeExtent.end().toTimeSpec( Qt::UTC ).toString( Qt::ISODate ) );
36 temporalElement.setAttribute( QStringLiteral( "matching-method" ), mMatchingMethod );
37 temporalElement.setAttribute( QStringLiteral( "always-load-reference-time-from-source" ), mAlwaysLoadReferenceTimeFromSource ? 1 : 0 );
38 element.appendChild( temporalElement );
39
40 return element;
41}
42
43bool QgsMeshLayerTemporalProperties::readXml( const QDomElement &element, const QgsReadWriteContext &context )
44{
45 Q_UNUSED( context );
46
47 const QDomElement temporalElement = element.firstChildElement( QStringLiteral( "temporal" ) );
48 const bool active = temporalElement.attribute( QStringLiteral( "temporal-active" ) ).toInt();
49 setIsActive( active );
50
51 mAlwaysLoadReferenceTimeFromSource = temporalElement.attribute( QStringLiteral( "always-load-reference-time-from-source" ) ).toInt();
52
53 mReferenceTime = QDateTime::fromString( temporalElement.attribute( QStringLiteral( "reference-time" ) ), Qt::ISODate );
54
55 if ( temporalElement.hasAttribute( QStringLiteral( "start-time-extent" ) )
56 && temporalElement.hasAttribute( QStringLiteral( "end-time-extent" ) ) )
57 {
58 const QDateTime start = QDateTime::fromString( temporalElement.attribute( QStringLiteral( "start-time-extent" ) ), Qt::ISODate );
59 const QDateTime end = QDateTime::fromString( temporalElement.attribute( QStringLiteral( "end-time-extent" ) ), Qt::ISODate );
60 mTimeExtent = QgsDateTimeRange( start, end );
61 }
62
64 temporalElement.attribute( QStringLiteral( "matching-method" ) ).toInt() );
65
66 mIsValid = true;
67 return true;
68}
69
71{
72 const QgsMeshDataProviderTemporalCapabilities *temporalCapabilities =
73 static_cast<const QgsMeshDataProviderTemporalCapabilities *>( capabilities );
74
75 setIsActive( temporalCapabilities->hasTemporalCapabilities() );
76 mReferenceTime = temporalCapabilities->referenceTime();
77
78 if ( mReferenceTime.isValid() )
79 mTimeExtent = temporalCapabilities->timeExtent();
80
81 mIsValid = true;
82}
83
88
90{
91 return mTimeExtent;
92}
93
95{
96 return mReferenceTime;
97}
98
99void QgsMeshLayerTemporalProperties::setReferenceTime( const QDateTime &referenceTime, const QgsDataProviderTemporalCapabilities *capabilities )
100{
101 mReferenceTime = referenceTime;
102 if ( capabilities )
103 {
104 const QgsMeshDataProviderTemporalCapabilities *tempCap = static_cast<const QgsMeshDataProviderTemporalCapabilities *>( capabilities );
105 mTimeExtent = tempCap->timeExtent( referenceTime );
106 }
107 else
109}
110
115
120
122{
123 return mIsValid;
124}
125
127{
128 mIsValid = isValid;
129}
130
132{
133 return mAlwaysLoadReferenceTimeFromSource;
134}
135
137{
138 mAlwaysLoadReferenceTimeFromSource = autoReloadFromProvider;
139}
Base class for handling properties relating to a data provider's temporal capabilities.
bool hasTemporalCapabilities() const
Returns true if the provider has temporal capabilities available.
Base class for storage of map layer temporal properties.
Base class for all map layer types.
Definition qgsmaplayer.h:75
Class for handling properties relating to a mesh data provider's temporal capabilities.
QDateTime referenceTime() const
Returns the reference time.
QgsDateTimeRange timeExtent() const
Returns the time extent using the internal reference time and the first and last times available from...
MatchingTemporalDatasetMethod
Method for selection of temporal mesh dataset from a range time.
QgsDateTimeRange calculateTemporalExtent(QgsMapLayer *layer) const override
Attempts to calculate the overall temporal extent for the specified layer, using the settings defined...
QDateTime referenceTime() const
Returns the reference time.
void setAlwaysLoadReferenceTimeFromSource(bool autoReloadFromProvider)
Sets whether the time proporties are automatically reloaded from provider when project is opened or l...
bool isValid() const
Returns whether the instance is valid.
QDomElement writeXml(QDomElement &element, QDomDocument &doc, const QgsReadWriteContext &context) override
Writes the properties to a DOM element, to be used later with readXml().
void setMatchingMethod(const QgsMeshDataProviderTemporalCapabilities::MatchingTemporalDatasetMethod &matchingMethod)
Sets the method used to match dataset from temporal capabilities.
QgsMeshDataProviderTemporalCapabilities::MatchingTemporalDatasetMethod matchingMethod() const
Returns the method used to match dataset from temporal capabilities.
void setReferenceTime(const QDateTime &referenceTime, const QgsDataProviderTemporalCapabilities *capabilities)
Sets the reference time and update the time extent from the temporal capabilities,...
void setDefaultsFromDataProviderTemporalCapabilities(const QgsDataProviderTemporalCapabilities *capabilities) override
Sets the layers temporal settings to appropriate defaults based on a provider's temporal capabilities...
bool alwaysLoadReferenceTimeFromSource() const
Returns whether the time proporties are automatically reloaded from provider when project is opened o...
void setIsValid(bool isValid)
Sets whether the instance is valid.
QgsDateTimeRange timeExtent() const
Returns the time extent.
QgsMeshLayerTemporalProperties(QObject *parent=nullptr, bool enabled=true)
Constructor for QgsMeshLayerTemporalProperties.
bool readXml(const QDomElement &element, const QgsReadWriteContext &context) override
Reads temporal properties from a DOM element previously written by writeXml().
The class is used as a container of context for various read/write operations on other objects.
bool isActive() const
Returns true if the temporal property is active.
void setIsActive(bool active)
Sets whether the temporal property is active.
T begin() const
Returns the beginning of the range.
Definition qgsrange.h:444
T end() const
Returns the upper bound of the range.
Definition qgsrange.h:451
QgsTemporalRange< QDateTime > QgsDateTimeRange
QgsRange which stores a range of date times.
Definition qgsrange.h:742