deepcave.plugins.static

# Static

This module provides a plugin class for a static plugin.

It provides an Enum used for the plugin state.

## Classes

• PluginState: An Enum to define the state of the Plugin.

• StaticPlugin: This class provides a static plugin object.

Classes

PluginState(value)	An Enum to define the state of the Plugin.
StaticPlugin()	Provide a static plugin object.

class deepcave.plugins.static.PluginState(value)

Bases: Enum

An Enum to define the state of the Plugin.

class deepcave.plugins.static.StaticPlugin

Bases: Plugin, ABC

Provide a static plugin object.

Calculation with queue. Made for time-consuming tasks. Register and handle callbacks.

Properties

outputsList[Tuple[str, str, bool]]

The plugin specific outputs.

inputsList[Tuple[str, str, bool, Any]]

The plugin specific inputs.

idstr

The plugin id.

raw_outputsdict[str, Any]

The raw outputs of a run.

loggerLogger

The logger for the plugin.

namestr

The name of the plugin.

processCallable

Return raw data based on a run and input data.

button_captionstr

The caption for the button.

__call__()

Return the components for the plugin.

Basically, all blocks and elements of the plugin are stacked-up here.

Returns:

Layout as list of components.

Return type:

List[Component]

register_callbacks()

Register different callbacks.

Return type:

None

previous

deepcave.plugins.objective

next

deepcave.plugins.summary