omni::log::ILogChannelFilter

class ILogChannelFilter : public omni::core::Generated<omni::log::ILogChannelFilter_abi>

Read-only object to encapsulate a channel filter’s pattern and effects.

A channel filter is a pattern matcher. If a channel’s name matches the pattern, the filter can set both the channel’s enabled flag and/or level.

Public Functions

inline const char *getFilter() noexcept

Returns the channels pattern. The returned memory is valid for the lifetime of this object.

This method is thread safe.

inline void getEnabled(bool *isEnabled, omni::log::SettingBehavior *behavior, bool *isUsed) noexcept

Returns the desired enabled state for this filter.

All parameters must not be nullptr.

If isUsed is false after calling this method, isEnabled and behavior should not be used.

This method is thread safe.

inline void getLevel(omni::log::Level *level, omni::log::SettingBehavior *behavior, bool *isUsed) noexcept

Returns the desired level for this filter.

All parameters must not be nullptr.

If isUsed is false after calling this method, level and behavior should not be used.

This method is thread safe.

inline bool isMatch(const char *channel) noexcept

Given a channel name, returns if the channel name matches the filter’s pattern.

The matching algorithm used is implementation specific (e.g. regex, glob, etc).

This method is thread safe.

inline void *cast(omni::core::TypeId id) noexcept

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety: This method is thread safe.

inline void acquire() noexcept

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety: This method is thread safe.

inline void release() noexcept

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety: This method is thread safe.

Protected Functions

virtual const char *getFilter_abi() noexcept = 0

Returns the channels pattern. The returned memory is valid for the lifetime of this object.

This method is thread safe.

virtual void getEnabled_abi(bool *isEnabled, SettingBehavior *behavior, bool *isUsed) noexcept = 0

Returns the desired enabled state for this filter.

All parameters must not be nullptr.

If isUsed is false after calling this method, isEnabled and behavior should not be used.

This method is thread safe.

virtual void getLevel_abi(Level *level, SettingBehavior *behavior, bool *isUsed) noexcept = 0

Returns the desired level for this filter.

All parameters must not be nullptr.

If isUsed is false after calling this method, level and behavior should not be used.

This method is thread safe.

virtual bool isMatch_abi(const char *channel) noexcept = 0

Given a channel name, returns if the channel name matches the filter’s pattern.

The matching algorithm used is implementation specific (e.g. regex, glob, etc).

This method is thread safe.

virtual void *cast_abi(TypeId id) noexcept = 0

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety: This method is thread safe.

virtual void acquire_abi() noexcept = 0

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety: This method is thread safe.

virtual void release_abi() noexcept = 0

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety: This method is thread safe.