flexbe_core.core.lockable_state_machine.LockableStateMachine Class Reference

Inheritance diagram for flexbe_core.core.lockable_state_machine.LockableStateMachine:

Public Member Functions
def	__init__ (self, args, kwargs)
def	execute (self, userdata)
def	get_deep_state (self)
def	get_locked_state (self)
def	is_locked (self)
def	is_locked_inside (self)
def	lock (self, path)
def	remove_state (self, state)
def	replace_state (self, state)
def	replace_userdata (self, userdata)
def	transition_allowed (self, state, outcome)
def	unlock (self, path)
Public Member Functions inherited from flexbe_core.core.ros_state_machine.RosStateMachine
def	__init__ (self, args, kwargs)
def	wait (self, seconds=None, condition=None)
Public Member Functions inherited from flexbe_core.core.state_machine.StateMachine
def	__contains__ (self, label)
def	__enter__ (self)
def	__exit__ (self, args)
def	__getitem__ (self, label)
def	__init__ (self, args, kwargs)
def	__iter__ (self)
def	assert_consistent_transitions (self)
def	current_state (self)
def	current_state_label (self)
def	execute (self, userdata)
def	initial_state (self)
def	initial_state_label (self)
def	sleep (self)
def	sleep_duration (self)
def	spin (self, userdata=None)
def	userdata (self)
Public Member Functions inherited from flexbe_core.core.state.State
def	__init__ (self, args, kwargs)
def	execute (self, userdata)
def	input_keys (self)
def	name (self)
def	outcomes (self)
def	output_keys (self)
def	parent (self)
def	path (self)
def	set_name (self, value)
def	set_parent (self, value)
def	sleep (self)
def	sleep_duration (self)

Static Public Attributes
	path_for_switch = None

Private Member Functions
def	_is_internal_transition (self, transition_target)

Private Attributes
	_current_state
	_locked
	_userdata

Additional Inherited Members
Static Public Member Functions inherited from flexbe_core.core.state_machine.StateMachine
def	add (label, state, transitions, remapping=None)
def	get_opened_container ()

Detailed Description

A state machine that can be locked.
When locked, no transition can be done regardless of the resulting outcome.
However, if any outcome would be triggered, the outcome will be stored
and the state won't be executed anymore until it is unlocked and the stored outcome is set.

Definition at line 5 of file lockable_state_machine.py.

Constructor & Destructor Documentation

def flexbe_core.core.lockable_state_machine.LockableStateMachine.__init__	(		self,
			args,
			kwargs
	)

Definition at line 14 of file lockable_state_machine.py.

Member Function Documentation

def flexbe_core.core.lockable_state_machine.LockableStateMachine._is_internal_transition (   self,   transition_target  )

private

Definition at line 29 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.execute	(		self,
			userdata
	)

Definition at line 42 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.get_deep_state

(

self

)

Looks for the current state (traversing all state machines down to the real state).

@return: The current state (not state machine)

Definition at line 18 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.get_locked_state

(

self

)

Definition at line 101 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.is_locked

(

self

)

Definition at line 85 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.is_locked_inside

(

self

)

Definition at line 88 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.lock	(		self,
			path
	)

Definition at line 67 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.remove_state	(		self,
			state
	)

Definition at line 61 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.replace_state	(		self,
			state
	)

Definition at line 55 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.replace_userdata	(		self,
			userdata
	)

Definition at line 52 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.transition_allowed	(		self,
			state,
			outcome
	)

Definition at line 32 of file lockable_state_machine.py.

def flexbe_core.core.lockable_state_machine.LockableStateMachine.unlock	(		self,
			path
	)

Definition at line 76 of file lockable_state_machine.py.

Member Data Documentation

flexbe_core.core.lockable_state_machine.LockableStateMachine._current_state

private

Definition at line 47 of file lockable_state_machine.py.

flexbe_core.core.lockable_state_machine.LockableStateMachine._locked

private

Definition at line 16 of file lockable_state_machine.py.

flexbe_core.core.lockable_state_machine.LockableStateMachine._userdata

private

Definition at line 53 of file lockable_state_machine.py.

flexbe_core.core.lockable_state_machine.LockableStateMachine.path_for_switch = None

static

Definition at line 12 of file lockable_state_machine.py.

---

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

• lockable_state_machine.py