KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QElapsedTimer

Notation used in Ruby API documentation

Module: QtCore

Description: Binding of QElapsedTimer

Sub-classes: ClockType, QFlags_ClockType

Public constructors

new QElapsedTimernewConstructor QElapsedTimer::QElapsedTimer()

Public methods

[const]bool!=(const QElapsedTimer other)Method bool QElapsedTimer::operator!=(const QElapsedTimer &other)
[const]bool==(const QElapsedTimer other)Method bool QElapsedTimer::operator==(const QElapsedTimer &other)
[const]QElapsedTimer ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidassign(const QElapsedTimer other)Assigns another object to self
[const]new QElapsedTimer ptrdupCreates a copy of self
[const]long longelapsedMethod qint64 QElapsedTimer::elapsed()
[const]boolhasExpired(long long timeout)Method bool QElapsedTimer::hasExpired(qint64 timeout)
voidinvalidateMethod void QElapsedTimer::invalidate()
[const]boolisValid?Method bool QElapsedTimer::isValid()
[const]long longmsecsSinceReferenceMethod qint64 QElapsedTimer::msecsSinceReference()
[const]long longmsecsTo(const QElapsedTimer other)Method qint64 QElapsedTimer::msecsTo(const QElapsedTimer &other)
[const]long longnsecsElapsedMethod qint64 QElapsedTimer::nsecsElapsed()
long longrestartMethod qint64 QElapsedTimer::restart()
[const]long longsecsTo(const QElapsedTimer other)Method qint64 QElapsedTimer::secsTo(const QElapsedTimer &other)
voidstartMethod void QElapsedTimer::start()

Public static methods and constants

[static,const]QElapsedTimer_ClockTypeMachAbsoluteTimeEnum constant QElapsedTimer::MachAbsoluteTime
[static,const]QElapsedTimer_ClockTypeMonotonicClockEnum constant QElapsedTimer::MonotonicClock
[static,const]QElapsedTimer_ClockTypePerformanceCounterEnum constant QElapsedTimer::PerformanceCounter
[static,const]QElapsedTimer_ClockTypeSystemTimeEnum constant QElapsedTimer::SystemTime
[static,const]QElapsedTimer_ClockTypeTickCounterEnum constant QElapsedTimer::TickCounter
QElapsedTimer_ClockTypeclockTypeStatic method QElapsedTimer::ClockType QElapsedTimer::clockType()
boolisMonotonic?Static method bool QElapsedTimer::isMonotonic()

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QElapsedTimer other)

Description: Method bool QElapsedTimer::operator!=(const QElapsedTimer &other)

==

Signature: [const] bool == (const QElapsedTimer other)

Description: Method bool QElapsedTimer::operator==(const QElapsedTimer &other)

MachAbsoluteTime

Signature: [static,const] QElapsedTimer_ClockType MachAbsoluteTime

Description: Enum constant QElapsedTimer::MachAbsoluteTime

Python specific notes:
The object exposes a readable attribute 'MachAbsoluteTime'. This is the getter.

MonotonicClock

Signature: [static,const] QElapsedTimer_ClockType MonotonicClock

Description: Enum constant QElapsedTimer::MonotonicClock

Python specific notes:
The object exposes a readable attribute 'MonotonicClock'. This is the getter.

PerformanceCounter

Signature: [static,const] QElapsedTimer_ClockType PerformanceCounter

Description: Enum constant QElapsedTimer::PerformanceCounter

Python specific notes:
The object exposes a readable attribute 'PerformanceCounter'. This is the getter.

SystemTime

Signature: [static,const] QElapsedTimer_ClockType SystemTime

Description: Enum constant QElapsedTimer::SystemTime

Python specific notes:
The object exposes a readable attribute 'SystemTime'. This is the getter.

TickCounter

Signature: [static,const] QElapsedTimer_ClockType TickCounter

Description: Enum constant QElapsedTimer::TickCounter

Python specific notes:
The object exposes a readable attribute 'TickCounter'. This is the getter.

_const_cast

Signature: [const] QElapsedTimer ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QElapsedTimer other)

Description: Assigns another object to self

clockType

Signature: [static] QElapsedTimer_ClockType clockType

Description: Static method QElapsedTimer::ClockType QElapsedTimer::clockType()

This method is static and can be called without an instance.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QElapsedTimer ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

elapsed

Signature: [const] long long elapsed

Description: Method qint64 QElapsedTimer::elapsed()

hasExpired

Signature: [const] bool hasExpired (long long timeout)

Description: Method bool QElapsedTimer::hasExpired(qint64 timeout)

invalidate

Signature: void invalidate

Description: Method void QElapsedTimer::invalidate()

isMonotonic?

Signature: [static] bool isMonotonic?

Description: Static method bool QElapsedTimer::isMonotonic()

This method is static and can be called without an instance.

isValid?

Signature: [const] bool isValid?

Description: Method bool QElapsedTimer::isValid()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

msecsSinceReference

Signature: [const] long long msecsSinceReference

Description: Method qint64 QElapsedTimer::msecsSinceReference()

msecsTo

Signature: [const] long long msecsTo (const QElapsedTimer other)

Description: Method qint64 QElapsedTimer::msecsTo(const QElapsedTimer &other)

new

Signature: [static] new QElapsedTimer new

Description: Constructor QElapsedTimer::QElapsedTimer()

This method creates an object of class QElapsedTimer.

Python specific notes:
This method is the default initializer of the object.

nsecsElapsed

Signature: [const] long long nsecsElapsed

Description: Method qint64 QElapsedTimer::nsecsElapsed()

restart

Signature: long long restart

Description: Method qint64 QElapsedTimer::restart()

secsTo

Signature: [const] long long secsTo (const QElapsedTimer other)

Description: Method qint64 QElapsedTimer::secsTo(const QElapsedTimer &other)

start

Signature: void start

Description: Method void QElapsedTimer::start()