hbp_nrp_cleserver.bibi_config.notificator module

This module implements an utility class for managing notifications during a simulation.

class Notificator

Bases: object

Notification manager for notification created during a simulation.

static notify(message, update_progress)

Forwards a notification to the currently registered notification function.

Parameters

• message – Title of the first subtask. Could be empty (example: loading Virtual Room).

• update_progress – Boolean. Index of current subtask should be updated? (usually yes).

static register_notification_function(notification_function)

Registers a notification function where to forward notifications.

Parameters

notification_function – The function to be registered.

class NotificatorHandler

Bases: logging.Handler

Log handler that forwards any logged messages to the notificator

emit(record)

Emits the record to the notificator

Parameters

record – The log record