omni.flux.factory.base#

  • SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.

  • SPDX-License-Identifier: Apache-2.0

  • Licensed under the Apache License, Version 2.0 (the “License”);

  • you may not use this file except in compliance with the License.

  • You may obtain a copy of the License at

  • https://www.apache.org/licenses/LICENSE-2.0

  • Unless required by applicable law or agreed to in writing, software

  • distributed under the License is distributed on an “AS IS” BASIS,

  • WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  • See the License for the specific language governing permissions and

  • limitations under the License.

class omni.flux.factory.base.FactoryBase#

Bases: Generic[T]

destroy()#
get_all_plugins() → dict[str, type[T]]#

Return all registered plugins

get_plugin_from_name(
plugin_name: str,
) → type[T] | None#

Get the plugin from a name

Parameters:

plugin_name – the name of the plugin to get

Returns:

The plugin

is_plugin_registered(name: str) → bool#

Check is the plugin is registered into the factory

Parameters:

name – the name of the plugin to check

Returns:

True if registered, else False

register_plugins(
plugins: list[type[T]],
)#

Register a plugin into the factory

Parameters:

plugins – the list of plugins to register

unregister_plugins(
plugins: list[type[T]],
)#

Unregister a plugin into the factory

Parameters:

plugins – the list of plugins to unregister

class omni.flux.factory.base.PluginBase#

Bases: ABC

name: ClassVar[str] = FieldInfo(annotation=NoneType, required=True)#