flexbe_core.core.event_state.EventState Class Reference

Inheritance diagram for flexbe_core.core.event_state.EventState:

Public Member Functions
def	__init__ (self, args, kwargs)
def	on_enter (self, userdata)
def	on_exit (self, userdata)
def	on_pause (self)
def	on_resume (self, userdata)
def	on_start (self)
def	on_stop (self)
Public Member Functions inherited from flexbe_core.core.operatable_state.OperatableState
def	__init__ (self, args, kwargs)
Public Member Functions inherited from flexbe_core.core.preemptable_state.PreemptableState
def	__init__ (self, args, kwargs)
Public Member Functions inherited from flexbe_core.core.loopback_state.LoopbackState
def	__init__ (self, args, kwargs)
Public Member Functions inherited from flexbe_core.core.lockable_state.LockableState
def	__init__ (self, args, kwargs)
def	is_locked (self)
Public Member Functions inherited from flexbe_core.core.manually_transitionable_state.ManuallyTransitionableState
def	__init__ (self, args, kwargs)
Public Member Functions inherited from flexbe_core.core.monitoring_state.MonitoringState
def	__init__ (self, args, kwargs)
def	force_monitoring (self)
def	monitor (self, key, outcome=None)

Public Attributes
	execute
Public Attributes inherited from flexbe_core.core.operatable_state.OperatableState
	autonomy
	execute
	transitions
Public Attributes inherited from flexbe_core.core.preemptable_state.PreemptableState
	execute
Public Attributes inherited from flexbe_core.core.loopback_state.LoopbackState
	execute
Public Attributes inherited from flexbe_core.core.lockable_state.LockableState
	execute
Public Attributes inherited from flexbe_core.core.manually_transitionable_state.ManuallyTransitionableState
	execute
Public Attributes inherited from flexbe_core.core.monitoring_state.MonitoringState
	execute
	name

Private Member Functions
def	_disable_ros_control (self)
def	_enable_ros_control (self)
def	_event_execute (self, args, kwargs)
def	_notify_skipped (self)

Private Attributes
	__execute
	_entering
	_feedback_topic
	_last_active_container
	_pause_topic
	_paused
	_pub
	_repeat_topic
	_skipped
	_sub

Additional Inherited Members
Static Public Attributes inherited from flexbe_core.core.preemptable_state.PreemptableState
bool	preempt = False
bool	switching = False

Detailed Description

A state that allows implementing certain events.

Definition at line 13 of file event_state.py.

Constructor & Destructor Documentation

def flexbe_core.core.event_state.EventState.__init__	(		self,
			args,
			kwargs
	)

Definition at line 18 of file event_state.py.

Member Function Documentation

def flexbe_core.core.event_state.EventState._disable_ros_control (   self )

private

Definition at line 97 of file event_state.py.

def flexbe_core.core.event_state.EventState._enable_ros_control (   self )

private

Definition at line 91 of file event_state.py.

def flexbe_core.core.event_state.EventState._event_execute (   self,   args,   kwargs  )

private

Definition at line 37 of file event_state.py.

def flexbe_core.core.event_state.EventState._notify_skipped (   self )

private

Definition at line 75 of file event_state.py.

def flexbe_core.core.event_state.EventState.on_enter	(		self,
			userdata
	)

Will be executed each time the state is entered from any other state (but not from itself).

Definition at line 133 of file event_state.py.

def flexbe_core.core.event_state.EventState.on_exit	(		self,
			userdata
	)

Will be executed each time the state will be left to any other state (but not to itself).

Definition at line 139 of file event_state.py.

def flexbe_core.core.event_state.EventState.on_pause

(

self

)

Will be executed each time this state is paused.

Definition at line 121 of file event_state.py.

def flexbe_core.core.event_state.EventState.on_resume	(		self,
			userdata
	)

Will be executed each time this state is resumed.

Definition at line 127 of file event_state.py.

def flexbe_core.core.event_state.EventState.on_start

(

self

)

Will be executed once when the behavior starts.

Definition at line 109 of file event_state.py.

def flexbe_core.core.event_state.EventState.on_stop

(

self

)

Will be executed once when the behavior stops or is preempted.

Definition at line 115 of file event_state.py.

Member Data Documentation

flexbe_core.core.event_state.EventState.__execute

private

Definition at line 23 of file event_state.py.

flexbe_core.core.event_state.EventState._entering

private

Definition at line 21 of file event_state.py.

flexbe_core.core.event_state.EventState._feedback_topic

private

Definition at line 29 of file event_state.py.

flexbe_core.core.event_state.EventState._last_active_container

private

Definition at line 27 of file event_state.py.

flexbe_core.core.event_state.EventState._pause_topic

private

Definition at line 31 of file event_state.py.

flexbe_core.core.event_state.EventState._paused

private

Definition at line 26 of file event_state.py.

flexbe_core.core.event_state.EventState._pub

private

Definition at line 33 of file event_state.py.

flexbe_core.core.event_state.EventState._repeat_topic

private

Definition at line 30 of file event_state.py.

flexbe_core.core.event_state.EventState._skipped

private

Definition at line 22 of file event_state.py.

flexbe_core.core.event_state.EventState._sub

private

Definition at line 34 of file event_state.py.

flexbe_core.core.event_state.EventState.execute

Definition at line 24 of file event_state.py.

---

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

• event_state.py