Notation used in Ruby API documentation
Module: tl
Description: A timer (stop watch)
The timer provides a way to measure CPU time. It provides two basic methods: start and stop. After it has been started and stopped again, the time can be retrieved using the user and sys attributes, i.e.:
t = RBA::Timer::new
t.start
# ... do something
t.stop
puts "it took #{t.sys} seconds (kernel), #{t.user} seconds (user) on the CPU"
The time is reported in seconds.
This class has been introduced in version 0.23.
| new Timer ptr | new | Creates a new object of this class |
| [const] | Timer ptr | _const_cast | Returns a non-const reference to self. | |
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly 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 | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const Timer other) | Assigns another object to self | |
| [const] | new Timer ptr | dup | Creates a copy of self | |
| void | start | Starts the timer | ||
| void | stop | Stops the timer | ||
| [const] | double | sys | Returns the elapsed CPU time in kernel mode from start to stop in seconds | |
| [const] | string | to_s | Produces a string with the currently elapsed times | |
| [const] | double | user | Returns the elapsed CPU time in user mode from start to stop in seconds | |
| [const] | double | wall | Returns the elapsed real time from start to stop in seconds |
| unsigned long | memory_size | Gets the current memory usage of the process in Bytes |
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
_const_cast | Signature: [const] Timer 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 Timer other) Description: Assigns another object to self |
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 Timer ptr dup Description: Creates a copy of self Python specific notes: |
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. |
memory_size | Signature: [static] unsigned long memory_size Description: Gets the current memory usage of the process in Bytes This method has been introduced in version 0.27. |
new | Signature: [static] new Timer ptr new Description: Creates a new object of this class Python specific notes: |
start | Signature: void start Description: Starts the timer |
stop | Signature: void stop Description: Stops the timer |
sys | Signature: [const] double sys Description: Returns the elapsed CPU time in kernel mode from start to stop in seconds |
to_s | Signature: [const] string to_s Description: Produces a string with the currently elapsed times Python specific notes: |
user | Signature: [const] double user Description: Returns the elapsed CPU time in user mode from start to stop in seconds |
wall | Signature: [const] double wall Description: Returns the elapsed real time from start to stop in seconds This method has been introduced in version 0.26. |