IStructuredLogSettings2

class omni.structuredlog.IStructuredLogSettings2

Bases: _IStructuredLogSettings2

Interface for the second 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.
set_output_flags(self, flags_to_add, ...)	Sets or clears one or more output flags for structured logging.

Attributes

heartbeat_period
need_log_headers
output_flags

__init__(*args, **kwargs)

Overloaded function.

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

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

set_output_flags(

self: omni.structuredlog._structuredlog._IStructuredLogSettings2,

flags_to_add: int,

flags_to_remove: int,

) → None

Sets or clears one or more output flags for structured logging.

@param[in] flagsToAdd A set of zero or more flag bits to set. These must be either

@ref omni::structuredlog::fOutputFlagNone or one or more of the @ref omni::structuredlog::OutputFlags flags.

@param[in] flagsToRemove A set of zero or more flag bits to cleared. These must be

either @ref omni::structuredlog::fOutputFlagNone or one or more of the @ref omni::structuredlog::OutputFlags flags.

@returns No return value.

@remarks This sets or clears flags that affect the output from the structured logging

system. These flags are all disabled by default. These flags will take effect the next time a message is emitted.