Public Member Functions | Public Attributes | Private Member Functions
hrl_lib.rutils.GenericListener Class Reference

Takes a normal ROS callback channel and gives it an on demand query style interface. More...

List of all members.

Public Member Functions

def __init__
 Message has to have a header.
def read
 Supported use cases rfid - want to get a reading, can be stale, no duplication allowed (allow None), query speed important hokuyo - want to get a reading, can be stale, no duplication allowed (don't want a None), willing to wait for new data (default) ft - want to get a reading, can be stale, duplication allowed (don't want a None), query speed important NOT ALLOWED duplication allowed, willing to wait for new data.

Public Attributes

 curid
 delay_tolerance
 last_call_back
 last_msg_returned
 message_extractor
 node_name
 reading

Private Member Functions

def _check_for_delivery_hiccups
def _wait_for_first_read

Detailed Description

Takes a normal ROS callback channel and gives it an on demand query style interface.

Definition at line 322 of file rutils.py.


Constructor & Destructor Documentation

def hrl_lib.rutils.GenericListener.__init__ (   self,
  node_name,
  message_type,
  listen_channel,
  frequency,
  message_extractor = None,
  queue_size = None 
)

Message has to have a header.

Parameters:
node_namename of node (if haven't been inited)
message_typetype of message to listen for
listen_channelROS channel to listen
frequencythe frequency to expect messages (used to print warning statements to console)
message_extractorfunction to preprocess the message into a desired format
queue_sizeROS subscriber queue (None = infinite)

Definition at line 331 of file rutils.py.


Member Function Documentation

Definition at line 379 of file rutils.py.

def hrl_lib.rutils.GenericListener._wait_for_first_read (   self,
  quiet = False 
) [private]

Definition at line 388 of file rutils.py.

def hrl_lib.rutils.GenericListener.read (   self,
  allow_duplication = False,
  willing_to_wait = True,
  warn = False,
  quiet = True 
)

Supported use cases rfid - want to get a reading, can be stale, no duplication allowed (allow None), query speed important hokuyo - want to get a reading, can be stale, no duplication allowed (don't want a None), willing to wait for new data (default) ft - want to get a reading, can be stale, duplication allowed (don't want a None), query speed important NOT ALLOWED duplication allowed, willing to wait for new data.

Definition at line 402 of file rutils.py.


Member Data Documentation

Definition at line 331 of file rutils.py.

Definition at line 331 of file rutils.py.

Definition at line 331 of file rutils.py.

Definition at line 331 of file rutils.py.

Definition at line 331 of file rutils.py.

Definition at line 331 of file rutils.py.

Definition at line 331 of file rutils.py.


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


hrl_lib
Author(s): Cressel Anderson, Travis Deyle, Advait Jain, Hai Nguyen, Advisor: Prof. Charlie Kemp, Lab: Healthcare Robotics Lab at Georgia Tech
autogenerated on Wed Nov 27 2013 11:34:06