QGIS/python/core/auto_generated/mesh/qgsmeshtimesettings.sip.in
Vincent Cloarec c252a3ad4c [mesh] Fixes time reference for mesh layer #32186 #33399 #31933 (#33410)
[FEATURE] [mesh] Load reference time from MDAL when available

Also adds combo box to let the user set the provider time unit. This is particularly useful when MDAL incorrectly recognised the time units in the raw dat format (for example format does nof follow spec and it is not possible to determine if time interval is in hours or days)

fix #32186 
fix #33399
fix #31933
2019-12-17 14:56:49 +01:00

127 lines
3.4 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshtimesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsMeshTimeSettings
{
%Docstring
Represents a mesh time settings for mesh datasets
.. versionadded:: 3.8
%End
%TypeHeaderCode
#include "qgsmeshtimesettings.h"
%End
public:
enum TimeUnit
{
//! second unit
seconds,
//! minute unit
minutes,
//! hour unit
hours,
//! day unit
days
};
QgsMeshTimeSettings();
QgsMeshTimeSettings( double relativeTimeOffsetHours, const QString &relativeTimeFormat );
%Docstring
Constructs relative time format settings with defined offset in hours
%End
QgsMeshTimeSettings( const QDateTime &absoluteTimeReferenceTime, const QString &absoluteTimeFormat );
%Docstring
Constructs absolute time format settings with defined reference time
%End
QDomElement writeXml( QDomDocument &doc, const QgsReadWriteContext &context ) const;
%Docstring
Writes configuration to a new DOM element
%End
void readXml( const QDomElement &elem, const QgsReadWriteContext &context );
%Docstring
Reads configuration from the given DOM element
%End
bool useAbsoluteTime() const;
%Docstring
Returns whether to use absolute time format
%End
void setUseAbsoluteTime( bool useAbsoluteTime );
%Docstring
Sets use absolute time flag
%End
double relativeTimeOffsetHours() const;
%Docstring
Returns number of offset hours for relative time formatting
%End
void setRelativeTimeOffsetHours( double relativeTimeOffsetHours );
%Docstring
Sets number of offset hours for relative time formatting
%End
QString relativeTimeFormat() const;
%Docstring
Returns format used for relative time
%End
void setRelativeTimeFormat( const QString &relativeTimeFormat );
%Docstring
Sets format used for relative time
%End
QDateTime absoluteTimeReferenceTime() const;
%Docstring
Returns reference time used for absolute time format
%End
void setAbsoluteTimeReferenceTime( const QDateTime &absoluteTimeReferenceTime );
%Docstring
Sets reference time used for absolute time format
%End
QString absoluteTimeFormat() const;
%Docstring
Returns format used for absolute time
%End
void setAbsoluteTimeFormat( const QString &absoluteTimeFormat );
%Docstring
Sets format used for absolute time
%End
TimeUnit providerTimeUnit() const;
%Docstring
Returns the provider time unit
.. versionadded:: 3.12
%End
void setProviderTimeUnit( const TimeUnit &providerTimeUnit );
%Docstring
Sets the provider time unit
.. versionadded:: 3.12
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/mesh/qgsmeshtimesettings.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/