Class: QgsMeshTimeSettings¶

class qgis.core.QgsMeshTimeSettings¶

Bases: sip.wrapper

QgsMeshTimeSettings(relativeTimeOffsetHours: float, relativeTimeFormat: str) Constructs relative time format settings with defined offset in hours

QgsMeshTimeSettings(absoluteTimeReferenceTime: Union[QDateTime, datetime.datetime], absoluteTimeFormat: str) Constructs absolute time format settings with defined reference time

QgsMeshTimeSettings(QgsMeshTimeSettings)

Represents a mesh time settings for mesh datasets

Methods

`absoluteTimeFormat`	Returns format used for absolute time
`absoluteTimeReferenceTime`	Returns reference time used for absolute time format
`providerTimeUnit`	Returns the provider time unit
`readXml`	Reads configuration from the given DOM element
`relativeTimeFormat`	Returns format used for relative time
`relativeTimeOffsetHours`	Returns number of offset hours for relative time formatting
`setAbsoluteTimeFormat`	Sets format used for absolute time
`setAbsoluteTimeReferenceTime`	Sets reference time used for absolute time format
`setProviderTimeUnit`	Sets the provider time unit
`setRelativeTimeFormat`	Sets format used for relative time
`setRelativeTimeOffsetHours`	Sets number of offset hours for relative time formatting
`setUseAbsoluteTime`	Sets use absolute time flag
`useAbsoluteTime`	Returns whether to use absolute time format
`writeXml`	Writes configuration to a new DOM element

Attributes

`days`
`hours`
`minutes`
`seconds`

class TimeUnit¶: Bases: int

absoluteTimeFormat(self) → str¶

Returns format used for absolute time

Return type: str

absoluteTimeReferenceTime(self) → QDateTime¶

Returns reference time used for absolute time format

Return type: QDateTime

days = 3¶

hours = 2¶

minutes = 1¶

providerTimeUnit(self) → QgsMeshTimeSettings.TimeUnit¶

Returns the provider time unit

New in version 3.12.

Return type: QgsMeshTimeSettings.TimeUnit

readXml(self, elem: QDomElement, context: QgsReadWriteContext)¶

Reads configuration from the given DOM element

Parameters

elem (QDomElement) –
context (QgsReadWriteContext) –

relativeTimeFormat(self) → str¶

Returns format used for relative time

Return type: str

relativeTimeOffsetHours(self) → float¶

Returns number of offset hours for relative time formatting

Return type: float

seconds = 0¶

setAbsoluteTimeFormat(self, absoluteTimeFormat: str)¶

Sets format used for absolute time

Parameters: absoluteTimeFormat (str) –

setAbsoluteTimeReferenceTime(self, absoluteTimeReferenceTime: Union[QDateTime, datetime.datetime])¶

Sets reference time used for absolute time format

Parameters: absoluteTimeReferenceTime (Union[QDateTime) –

setProviderTimeUnit(self, providerTimeUnit: QgsMeshTimeSettings.TimeUnit)¶

Sets the provider time unit

New in version 3.12.

Parameters: providerTimeUnit (QgsMeshTimeSettings.TimeUnit) –

setRelativeTimeFormat(self, relativeTimeFormat: str)¶

Sets format used for relative time

Parameters: relativeTimeFormat (str) –

setRelativeTimeOffsetHours(self, relativeTimeOffsetHours: float)¶

Sets number of offset hours for relative time formatting

Parameters: relativeTimeOffsetHours (float) –

setUseAbsoluteTime(self, useAbsoluteTime: bool)¶

Sets use absolute time flag

Parameters: useAbsoluteTime (bool) –

useAbsoluteTime(self) → bool¶

Returns whether to use absolute time format

Return type: bool

writeXml(self, doc: QDomDocument, context: QgsReadWriteContext) → QDomElement¶

Writes configuration to a new DOM element

Parameters

doc (QDomDocument) –
context (QgsReadWriteContext) –

Return type

QDomElement