Inheritance diagram for flexbe_states.calculation_state.CalculationState:
Public Member Functions | |
| def | __init__ (self, calculation) |
| def | execute (self, userdata) |
| def | on_enter (self, userdata) |
Private Attributes | |
| _calculation | |
| _calculation_result | |
Detailed Description
Implements a state that can perform a calculation based on userdata.
calculation is a function which takes exactly one parameter, input_value from userdata,
and its return value is stored in output_value after leaving the state.
-- calculation function The function that performs the desired calculation.
It could be a private function (self.foo) manually defined in a behavior's source code
or a lambda function (e.g., lambda x: x^2, where x will be the input_value).
># input_value object Input to the calculation function.
#> output_value object The result of the calculation.
<= done Indicates completion of the calculation.
Definition at line 5 of file calculation_state.py.
Constructor & Destructor Documentation
◆ __init__()
| def flexbe_states.calculation_state.CalculationState.__init__ | ( | self, | |
| calculation | |||
| ) |
Definition at line 22 of file calculation_state.py.
Member Function Documentation
◆ execute()
| def flexbe_states.calculation_state.CalculationState.execute | ( | self, | |
| userdata | |||
| ) |
Definition at line 29 of file calculation_state.py.
◆ on_enter()
| def flexbe_states.calculation_state.CalculationState.on_enter | ( | self, | |
| userdata | |||
| ) |
Definition at line 34 of file calculation_state.py.
Member Data Documentation
◆ _calculation
|
private |
Definition at line 26 of file calculation_state.py.
◆ _calculation_result
|
private |
Definition at line 27 of file calculation_state.py.
The documentation for this class was generated from the following file: