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

Public Member Functions

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

Private Member Functions

def _get_msg_from_path (self, msg_path)
 

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 15 of file subscriber_state.py.

Constructor & Destructor Documentation

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

Definition at line 32 of file subscriber_state.py.

Member Function Documentation

def flexbe_states.subscriber_state.SubscriberState._get_msg_from_path (   self,
  msg_path 
)
private

Definition at line 83 of file subscriber_state.py.

def flexbe_states.subscriber_state.SubscriberState.execute (   self,
  userdata 
)
Execute this state

Definition at line 54 of file subscriber_state.py.

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

Definition at line 68 of file subscriber_state.py.

Member Data Documentation

flexbe_states.subscriber_state.SubscriberState._blocking
private

Definition at line 40 of file subscriber_state.py.

flexbe_states.subscriber_state.SubscriberState._clear
private

Definition at line 41 of file subscriber_state.py.

flexbe_states.subscriber_state.SubscriberState._connected
private

Definition at line 42 of file subscriber_state.py.

flexbe_states.subscriber_state.SubscriberState._sub
private

Definition at line 48 of file subscriber_state.py.

flexbe_states.subscriber_state.SubscriberState._topic
private

Definition at line 39 of file subscriber_state.py.


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


flexbe_states
Author(s): Philipp Schillinger
autogenerated on Wed Jun 5 2019 21:52:08