ror.stages.common package

Submodules

ror.stages.common.i_base_stage module

class ror.stages.common.i_base_stage.IBaseStage

Bases: Generic[I, O]

Interface extended by all the additional stages which exclicitly defines that all stages should expect the set_input, compute`and `get_output as public methods which is essential for the controllers.

Parameters:

Generic (Generic) – Typing generic used to explicitly define the input dataclass of the stage and the output dataclass in the stage.

compute() → None

get_output() → O

Returns the output dataclass as type O defined in the construction.

Returns:

Output dataclass defined for this stage.

Return type:

O

set_input(input: I) → None

Given an input from the last stage or init dataclass, set the local state for this stage -> data used in compute.

Parameters:

input (I) – Input dataclass of the define input dataclass I.

Module contents