UM.Qt.Duration.Duration Class Reference

A class representing a time duration. More...

Inherits QObject.

Public Member Functions
def	__init__
	Create a duration object. More...
def	days (self)
def	hours (self)
def	minutes (self)
def	seconds (self)
def	valid (self)
def	isTotalDurationZero (self)
def	setDuration
	Set the duration in seconds. More...
def	getDisplayString
	Get a string representation of this object that can be used to display in interfaces. More...
def	__int__ (self)
	Get an integer representation of this duration. More...

Static Public Attributes
tuple	durationChanged = pyqtSignal()

Detailed Description

A class representing a time duration.

This is primarily used as a value type to QML so we can report things like "How long will this print take" without needing a bunch of logic in the QML.

Constructor & Destructor Documentation

def UM.Qt.Duration.Duration.__init__	(		self,
			duration
	)

Create a duration object.

Parameters

duration	The duration in seconds. If this is None (the default), an invalid Duration object will be created.
parent	The QObject parent.

Member Function Documentation

def UM.Qt.Duration.Duration.__int__

(

self

)

Get an integer representation of this duration.

The integer contains the number of seconds in the duration. Convert it back to a Duration instance by providing the number of seconds to the constructor.

def UM.Qt.Duration.Duration.getDisplayString	(		self,
			display_format = DurationFormat.Format.Short
	)

Get a string representation of this object that can be used to display in interfaces.

This is not called toString() primarily because that conflicts with JavaScript's toString().

Returns

A human-readable string representation of this duration.

def UM.Qt.Duration.Duration.setDuration	(		self,
			duration
	)

Set the duration in seconds.

This will convert the given amount of seconds into an amount of days, hours, minutes and seconds. Note that this is mostly a workaround for issues with PyQt, as a value type this class should not really have a setter.

---

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

• UM/Qt/Duration.py