API reference - Class Logger

Notation used in Ruby API documentation

Module: tl

Description: A logger

The logger outputs messages to the log channels. If the log viewer is open, the log messages will be shown in the logger view. Otherwise they will be printed to the terminal on Linux for example.

A code example:

RBA::Logger::error("An error message")
RBA::Logger::warn("A warning")

This class has been introduced in version 0.23.

Public constructors

new Logger ptrnewCreates a new object of this class

Public methods

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 Logger other)Assigns another object to self
[const]new Logger ptrdupCreates a copy of self

Public static methods and constants

voiderror(string msg)Writes the given string to the error channel
voidinfo(string msg)Writes the given string to the info channel
voidlog(string msg)Writes the given string to the log channel
intverbosityReturns the verbosity level
voidverbosity=(int v)Sets the verbosity level for the application
voidwarn(string msg)Writes the given string to the warning channel

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

_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 Logger 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 Logger ptr dup

Description: Creates a copy of self

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

error

Signature: [static] void error (string msg)

Description: Writes the given string to the error channel

The error channel is formatted as an error (i.e. red in the logger window) and output unconditionally.

info

Signature: [static] void info (string msg)

Description: Writes the given string to the info channel

The info channel is printed as neutral messages unconditionally.

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.

log

Signature: [static] void log (string msg)

Description: Writes the given string to the log channel

Log messages are printed as neutral messages and are output only if the verbosity is above 0.

new

Signature: [static] new Logger ptr new

Description: Creates a new object of this class

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

verbosity

Signature: [static] int verbosity

Description: Returns the verbosity level

The verbosity level is defined by the application (see -d command line option for example). Level 0 is silent, levels 10, 20, 30 etc. denote levels with increasing verbosity. 11, 21, 31 .. are sublevels which also enable timing logs in addition to messages.

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

verbosity=

Signature: [static] void verbosity= (int v)

Description: Sets the verbosity level for the application

See verbosity for a definition of the verbosity levels. Please note that this method changes the verbosity level for the whole application.

Python specific notes:
The object exposes a writable attribute 'verbosity'. This is the setter.

warn

Signature: [static] void warn (string msg)

Description: Writes the given string to the warning channel

The warning channel is formatted as a warning (i.e. blue in the logger window) and output unconditionally.