QGIS API Documentation  3.21.0-Master (5b68dc587e)
Public Types | Public Member Functions | List of all members
QgsMeshTimeSettings Class Reference

Represents a mesh time settings for mesh datasets. More...

#include <qgsmeshtimesettings.h>

Public Types

enum  TimeUnit { seconds = 0 , minutes , hours , days }
 Time units used to display time. More...
 

Public Member Functions

 QgsMeshTimeSettings ()
 
QString absoluteTimeFormat () const
 Returns format used for absolute time. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context)
 Reads configuration from the given DOM element. More...
 
QString relativeTimeFormat () const
 Returns format used for relative time. More...
 
void setAbsoluteTimeFormat (const QString &absoluteTimeFormat)
 Sets format used for absolute time. More...
 
void setRelativeTimeFormat (const QString &relativeTimeFormat)
 Sets format used for relative time. More...
 
QDomElement writeXml (QDomDocument &doc, const QgsReadWriteContext &context) const
 Writes configuration to a new DOM element. More...
 

Detailed Description

Represents a mesh time settings for mesh datasets.

Since
QGIS 3.8

Definition at line 35 of file qgsmeshtimesettings.h.

Member Enumeration Documentation

◆ TimeUnit

Time units used to display time.

Since
QGIS 3.12
Enumerator
seconds 

second unit

minutes 

minute unit

hours 

hour unit

days 

day unit

Definition at line 43 of file qgsmeshtimesettings.h.

Constructor & Destructor Documentation

◆ QgsMeshTimeSettings()

QgsMeshTimeSettings::QgsMeshTimeSettings ( )
default

Member Function Documentation

◆ absoluteTimeFormat()

QString QgsMeshTimeSettings::absoluteTimeFormat ( ) const

Returns format used for absolute time.

Definition at line 49 of file qgsmeshtimesettings.cpp.

◆ readXml()

void QgsMeshTimeSettings::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context 
)

Reads configuration from the given DOM element.

Definition at line 32 of file qgsmeshtimesettings.cpp.

◆ relativeTimeFormat()

QString QgsMeshTimeSettings::relativeTimeFormat ( ) const

Returns format used for relative time.

Definition at line 39 of file qgsmeshtimesettings.cpp.

◆ setAbsoluteTimeFormat()

void QgsMeshTimeSettings::setAbsoluteTimeFormat ( const QString &  absoluteTimeFormat)

Sets format used for absolute time.

Definition at line 54 of file qgsmeshtimesettings.cpp.

◆ setRelativeTimeFormat()

void QgsMeshTimeSettings::setRelativeTimeFormat ( const QString &  relativeTimeFormat)

Sets format used for relative time.

Definition at line 44 of file qgsmeshtimesettings.cpp.

◆ writeXml()

QDomElement QgsMeshTimeSettings::writeXml ( QDomDocument &  doc,
const QgsReadWriteContext context 
) const

Writes configuration to a new DOM element.

Definition at line 23 of file qgsmeshtimesettings.cpp.


The documentation for this class was generated from the following files: