IStructuredLogSettings3#

class omni.structuredlog.IStructuredLogSettings3#

Bases: _IStructuredLogSettings3

Interface for the third version of the IStructuredLogSettings interface. This interface exposes more settings to control the behaviour of the structured logging system. This object can be retrieved directly or by casting the main IStructuredLog interface to this type using ``omni::core::ObjectPtr::as<>()``.

Methods

__init__(*args, **kwargs)

Overloaded function.

settings_load_complete(self)

This function informs the structured log system that the settings registry is fully loaded.

Attributes

message_source_tag

__init__(*args, **kwargs)#

Overloaded function.

  1. __init__(self: omni.structuredlog._structuredlog.IStructuredLogSettings3, arg0: omni.core._core.IObject) -> None

  2. __init__(self: omni.structuredlog._structuredlog.IStructuredLogSettings3) -> None

settings_load_complete(
self: omni.structuredlog._structuredlog._IStructuredLogSettings3,
) → None#

This function informs the structured log system that the settings registry is fully loaded.

@remarks Because omni.structuredlog loads very early in the process, it is typically loaded

before ``ISettings``, so it needs to be explicitly told when it’s safe to start reading from the settings registry. This function will flag this internally and may also read some settings from the registry.