flexbe_states.subscriber_state.SubscriberState Class Reference

Inheritance diagram for flexbe_states.subscriber_state.SubscriberState:

Public Member Functions
def	__init__ (self, topic, blocking=True, clear=False)
def	execute (self, userdata)
def	on_enter (self, userdata)

Private Member Functions
def	_connect (self)

Private Attributes
	_blocking
	_clear
	_connected
	_sub
	_topic

Detailed Description

Gets the latest message on the given topic and stores it to userdata.

-- topic                string          The topic on which should be listened.
-- blocking     bool            Blocks until a message is received.
-- clear                bool            Drops last message on this topic on enter
                            in order to only handle message received since this state is active.

#> message              object          Latest message on the given topic of the respective type.

<= received                             Message has been received and stored in userdata or state is not blocking.
<= unavailable                          The topic is not available when this state becomes actives.

Definition at line 9 of file subscriber_state.py.

Constructor & Destructor Documentation

__init__()

def flexbe_states.subscriber_state.SubscriberState.__init__	(		self,
			topic,
			blocking = True,
			clear = False
	)

Definition at line 24 of file subscriber_state.py.

Member Function Documentation

_connect()

def flexbe_states.subscriber_state.SubscriberState._connect (   self )

private

Definition at line 56 of file subscriber_state.py.

execute()

def flexbe_states.subscriber_state.SubscriberState.execute	(		self,
			userdata
	)

Definition at line 36 of file subscriber_state.py.

on_enter()

def flexbe_states.subscriber_state.SubscriberState.on_enter	(		self,
			userdata
	)

Definition at line 46 of file subscriber_state.py.

Member Data Documentation

_blocking

flexbe_states.subscriber_state.SubscriberState._blocking

private

Definition at line 28 of file subscriber_state.py.

_clear

flexbe_states.subscriber_state.SubscriberState._clear

private

Definition at line 29 of file subscriber_state.py.

_connected

flexbe_states.subscriber_state.SubscriberState._connected

private

Definition at line 30 of file subscriber_state.py.

_sub

flexbe_states.subscriber_state.SubscriberState._sub

private

Definition at line 62 of file subscriber_state.py.

_topic

flexbe_states.subscriber_state.SubscriberState._topic

private

Definition at line 27 of file subscriber_state.py.

---

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

• subscriber_state.py