rate_publishers._RatePublisher Class Reference

Inheritance diagram for rate_publishers._RatePublisher:

Public Member Functions
def	__init__ (self, topic, msg_type, latch=False)
def	pub (self, message, rate=None)
def	publish_once (self)
def	spin_once (self)
def	stop (self)

Private Attributes
	_last_pub
	_message
	_period
	_publisher
	_topic

Static Private Attributes
float	_tolerance = 0.01

Detailed Description

Definition at line 33 of file rate_publishers.py.

Constructor & Destructor Documentation

__init__()

def rate_publishers._RatePublisher.__init__	(		self,
			topic,
			msg_type,
			latch = False
	)

Definition at line 39 of file rate_publishers.py.

Member Function Documentation

pub()

def rate_publishers._RatePublisher.pub	(		self,
			message,
			rate = None
	)

Definition at line 46 of file rate_publishers.py.

publish_once()

def rate_publishers._RatePublisher.publish_once

(

self

)

Definition at line 54 of file rate_publishers.py.

spin_once()

def rate_publishers._RatePublisher.spin_once

(

self

)

Gives _RatePublisher a chance to publish a stored message.

This method returns the remaining time until the next scheduled
publication (or -1).

Definition at line 59 of file rate_publishers.py.

stop()

def rate_publishers._RatePublisher.stop

(

self

)

Definition at line 51 of file rate_publishers.py.

Member Data Documentation

_last_pub

rate_publishers._RatePublisher._last_pub

private

Definition at line 44 of file rate_publishers.py.

_message

rate_publishers._RatePublisher._message

private

Definition at line 42 of file rate_publishers.py.

_period

rate_publishers._RatePublisher._period

private

Definition at line 43 of file rate_publishers.py.

_publisher

rate_publishers._RatePublisher._publisher

private

Definition at line 41 of file rate_publishers.py.

_tolerance

float rate_publishers._RatePublisher._tolerance = 0.01

staticprivate

Definition at line 37 of file rate_publishers.py.

_topic

rate_publishers._RatePublisher._topic

private

Definition at line 40 of file rate_publishers.py.

---

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

• rate_publishers.py