CollectFileConcept

CollectFileConcept

CollectFileConcept(manager)

              flowchart LR
              task_schema.plugins.maya_3d_plugin.CollectFileConcept[CollectFileConcept]
              task_schema.plugins.maya_3d_plugin.CollectFile[CollectFile]
              publisher.core.Collect[Collect]
              publisher.core.Process[Process]

                              task_schema.plugins.maya_3d_plugin.CollectFile --> task_schema.plugins.maya_3d_plugin.CollectFileConcept
                                publisher.core.Collect --> task_schema.plugins.maya_3d_plugin.CollectFile
                                publisher.core.Process --> publisher.core.Collect
                




              click task_schema.plugins.maya_3d_plugin.CollectFileConcept href "" "task_schema.plugins.maya_3d_plugin.CollectFileConcept"
              click task_schema.plugins.maya_3d_plugin.CollectFile href "" "task_schema.plugins.maya_3d_plugin.CollectFile"
              click publisher.core.Collect href "" "publisher.core.Collect"
              click publisher.core.Process href "" "publisher.core.Process"
            

Methods:

• add_callback –

  Adds a callback function to be executed after the process finishes.

• add_error –

  Adds an error to the list of errors.

• set_status –

  Sets the status of the process.

Attributes:

• callbacks (Dict[Type[Callback], Callable]) –

  Returns the dict of registered callbacks.

• context (Context) –

  Returns the shared context.

• errors (List[ErrorProcess]) –

  Returns the list of errors encountered during execution.

• status (StatusProcess) –

  Returns the current status of the process.

• value (Any) –

  Returns the current collected value.

callbacks property

callbacks: Dict[Type[Callback], Callable]

Returns the dict of registered callbacks.

context property

context: Context

Returns the shared context.

errors property

errors: List[ErrorProcess]

Returns the list of errors encountered during execution.

status property

status: StatusProcess

Returns the current status of the process.

value property writable

value: Any

Returns the current collected value.

add_callback

add_callback(callback_type: Callback, callback: callable) -> None

Adds a callback function to be executed after the process finishes.

add_error

add_error(error: Optional[str] = 'Unknown error', details: Optional[str] = 'Unknown details', items: Optional[List[str]] = None) -> None

Adds an error to the list of errors.

Parameters:

• error

  (str, default: 'Unknown error' ) –

  The error message or name.

• details

  (str, default: 'Unknown details' ) –

  Detailed description of the error.

• items

  (list, default: None ) –

  Optional list of items related to the error.

set_status

set_status(status: StatusProcess) -> None

Sets the status of the process.

Parameters:

• status

  (StatusProcess) –

  Set status.