Public Member Functions | Private Attributes
hrl_lib.timer.Timer Class Reference

List of all members.

Public Member Functions

def __init__
def run
def shutdown

Private Attributes

 _callback
 _oneshot
 _period
 _shutdown

Detailed Description

Convenience class for calling a callback at a specified rate

Definition at line 67 of file timer.py.


Constructor & Destructor Documentation

def hrl_lib.timer.Timer.__init__ (   self,
  period,
  callback,
  oneshot = False 
)
Constructor.
@param period: desired period between callbacks
@type  period: rospy.Time
@param callback: callback to be called
@type  callback: function taking rospy.TimerEvent
@param oneshot: if True, fire only once, otherwise fire continuously until shutdown is called [default: False]
@type  oneshot: bool

Definition at line 72 of file timer.py.


Member Function Documentation

def hrl_lib.timer.Timer.run (   self)

Definition at line 96 of file timer.py.

Stop firing callbacks.

Definition at line 90 of file timer.py.


Member Data Documentation

Definition at line 80 of file timer.py.

Definition at line 80 of file timer.py.

Definition at line 80 of file timer.py.

Definition at line 80 of file timer.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