Public Member Functions | Private Attributes | List of all members
flexbe_states.check_condition_state.CheckConditionState Class Reference
Inheritance diagram for flexbe_states.check_condition_state.CheckConditionState:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, predicate)
 
def execute (self, userdata)
 
def on_enter (self, userdata)
 

Private Attributes

 _outcome
 
 _predicate
 

Detailed Description

Checks if the given condition is true and returns the corresponding outcome.
This state can be used if the further control flow of the behavior depends on a simple condition.

-- predicate    function        The condition whose truth value will be evaluated.
                            Has to expect one parameter which will be set to input_value and return a boolean.

># input_value  object          Input to the predicate function.

<= true                                         Returned if the condition evaluates to True
<= false                                        Returned if the condition evaluates to False

Definition at line 5 of file check_condition_state.py.

Constructor & Destructor Documentation

def flexbe_states.check_condition_state.CheckConditionState.__init__ (   self,
  predicate 
)

Definition at line 19 of file check_condition_state.py.

Member Function Documentation

def flexbe_states.check_condition_state.CheckConditionState.execute (   self,
  userdata 
)

Definition at line 25 of file check_condition_state.py.

def flexbe_states.check_condition_state.CheckConditionState.on_enter (   self,
  userdata 
)

Definition at line 28 of file check_condition_state.py.

Member Data Documentation

flexbe_states.check_condition_state.CheckConditionState._outcome
private

Definition at line 23 of file check_condition_state.py.

flexbe_states.check_condition_state.CheckConditionState._predicate
private

Definition at line 22 of file check_condition_state.py.


The documentation for this class was generated from the following file:


flexbe_states
Author(s): Philipp Schillinger
autogenerated on Sun Dec 13 2020 04:01:46