QGIS API Documentation 3.37.0-Master (c2d15952569)
Loading...
Searching...
No Matches
qgsprojecttimesettings.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsprojecttimesettings.cpp
3 ---------------
4 begin : February 2020
5 copyright : (C) 2020 by Samweli Mwakisambwe
6 email : samweli at kartoza 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
19#include "qgis.h"
20#include "qgsunittypes.h"
21#include <QDomElement>
22
24 : QObject( parent )
25{
26
27}
28
34
39
41{
42 if ( range == mRange )
43 return;
44 mRange = range;
45
47}
48
49bool QgsProjectTimeSettings::readXml( const QDomElement &element, const QgsReadWriteContext & )
50{
51 const QDomElement temporalElement = element.firstChildElement( QStringLiteral( "TemporalRange" ) );
52 if ( !temporalElement.isNull() )
53 {
54 const QDomNode begin = temporalElement.namedItem( QStringLiteral( "start" ) );
55 const QDomNode end = temporalElement.namedItem( QStringLiteral( "end" ) );
56
57 const QDateTime beginDate = QDateTime::fromString( begin.toElement().text(), Qt::ISODate );
58 const QDateTime endDate = QDateTime::fromString( end.toElement().text(), Qt::ISODate );
59
60 setTemporalRange( QgsDateTimeRange( beginDate, endDate ) );
61
62 }
63
64 mTimeStepUnit = QgsUnitTypes::decodeTemporalUnit( element.attribute( QStringLiteral( "timeStepUnit" ), QgsUnitTypes::encodeUnit( Qgis::TemporalUnit::Hours ) ) );
65 mTimeStep = element.attribute( QStringLiteral( "timeStep" ), "1" ).toDouble();
66 mFrameRate = element.attribute( QStringLiteral( "frameRate" ), "1" ).toDouble();
67 mCumulativeTemporalRange = element.attribute( QStringLiteral( "cumulativeTemporalRange" ), "0" ).toInt();
68
69 mTotalMovieFrames = element.attribute( QStringLiteral( "totalMovieFrames" ), "100" ).toLongLong();
70
71 return true;
72}
73
74QDomElement QgsProjectTimeSettings::writeXml( QDomDocument &document, const QgsReadWriteContext & ) const
75{
76 QDomElement element = document.createElement( QStringLiteral( "ProjectTimeSettings" ) );
77
78 if ( mRange.begin().isValid() && mRange.end().isValid() )
79 {
80 QDomElement temporalElement = document.createElement( QStringLiteral( "TemporalRange" ) );
81 QDomElement startElement = document.createElement( QStringLiteral( "start" ) );
82 QDomElement endElement = document.createElement( QStringLiteral( "end" ) );
83
84 const QDomText startText = document.createTextNode( mRange.begin().toTimeSpec( Qt::OffsetFromUTC ).toString( Qt::ISODate ) );
85 const QDomText endText = document.createTextNode( mRange.end().toTimeSpec( Qt::OffsetFromUTC ).toString( Qt::ISODate ) );
86
87 startElement.appendChild( startText );
88 endElement.appendChild( endText );
89
90 temporalElement.appendChild( startElement );
91 temporalElement.appendChild( endElement );
92
93 element.appendChild( temporalElement );
94 }
95
96 element.setAttribute( QStringLiteral( "timeStepUnit" ), QgsUnitTypes::encodeUnit( mTimeStepUnit ) );
97 element.setAttribute( QStringLiteral( "timeStep" ), qgsDoubleToString( mTimeStep ) );
98 element.setAttribute( QStringLiteral( "frameRate" ), qgsDoubleToString( mFrameRate ) );
99 element.setAttribute( QStringLiteral( "cumulativeTemporalRange" ), mCumulativeTemporalRange ? 1 : 0 );
100 element.setAttribute( QStringLiteral( "totalMovieFrames" ), mTotalMovieFrames );
101
102 return element;
103}
104
106{
107 return mTimeStepUnit;
108}
109
111{
112 mTimeStepUnit = unit;
113}
114
116{
117 return mTimeStep;
118}
119
121{
122 mTimeStep = timeStep;
123}
124
126{
127 mFrameRate = rate;
128}
129
131{
132 return mFrameRate;
133}
134
136{
137 mCumulativeTemporalRange = state;
138}
139
141{
142 return mCumulativeTemporalRange;
143}
144
146{
147 return mTotalMovieFrames;
148}
149
151{
152 mTotalMovieFrames = frames;
153}
154
TemporalUnit
Temporal units.
Definition qgis.h:4169
long long totalMovieFrames() const
Returns the total number of frames for the project's movie.
QgsDateTimeRange temporalRange() const
Returns the project's temporal range, which indicates the earliest and latest datetime ranges associa...
void setTotalMovieFrames(long long frames)
Sets the total number of frames for the movie.
void setTemporalRange(const QgsDateTimeRange &range)
Sets the project's temporal range, which indicates the earliest and latest datetime ranges associated...
double timeStep() const
Returns the project's time step (length of one animation frame), which is used as the default value w...
void setFramesPerSecond(double rate)
Sets the project's default animation frame rate, in frames per second.
bool readXml(const QDomElement &element, const QgsReadWriteContext &context)
Reads the settings's state from a DOM element.
void temporalRangeChanged()
Emitted when the temporal range changes.
Qgis::TemporalUnit timeStepUnit() const
Returns the project's time step (length of one animation frame) unit, which is used as the default va...
QgsProjectTimeSettings(QObject *parent=nullptr)
Constructor for QgsProjectTimeSettings with the specified parent object.
bool isTemporalRangeCumulative() const
Returns the value of cumulative temporal range in animation settings.
void setTimeStepUnit(Qgis::TemporalUnit unit)
Sets the project's time step (length of one animation frame) unit, which is used as the default value...
void setIsTemporalRangeCumulative(bool state)
Sets the project's temporal range as cumulative in animation settings.
void reset()
Resets the settings to a default state.
QDomElement writeXml(QDomDocument &document, const QgsReadWriteContext &context) const
Returns a DOM element representing the settings.
void setTimeStep(double step)
Sets the project's time step (length of one animation frame), which is used as the default value when...
double framesPerSecond() const
Returns the project's default animation frame rate, in frames per second.
The class is used as a container of context for various read/write operations on other objects.
T begin() const
Returns the beginning of the range.
Definition qgsrange.h:390
T end() const
Returns the upper bound of the range.
Definition qgsrange.h:397
static Q_INVOKABLE Qgis::TemporalUnit decodeTemporalUnit(const QString &string, bool *ok=nullptr)
Decodes a temporal unit from a string.
static Q_INVOKABLE QString encodeUnit(Qgis::DistanceUnit unit)
Encodes a distance unit to a string.
QString qgsDoubleToString(double a, int precision=17)
Returns a string representation of a double.
Definition qgis.h:5061
QgsTemporalRange< QDateTime > QgsDateTimeRange
QgsRange which stores a range of date times.
Definition qgsrange.h:688