diagnostic_updater._publisher.TopicDiagnostic Class Reference

Inheritance diagram for diagnostic_updater._publisher.TopicDiagnostic:

Public Member Functions
def	__init__ (self, name, diag, freq, stamp)
def	tick (self, stamp)
Public Member Functions inherited from diagnostic_updater._publisher.HeaderlessTopicDiagnostic
def	__init__ (self, name, diag, freq)
def	clear_window (self)
def	tick (self)
Public Member Functions inherited from diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask
def	__init__ (self, name)
def	addTask (self, t)
def	run (self, stat)
Public Member Functions inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
def	__init__ (self, name)
def	getName (self)
def	run (self, stat)

Public Attributes
	stamp
Public Attributes inherited from diagnostic_updater._publisher.HeaderlessTopicDiagnostic
	diag
	freq
Public Attributes inherited from diagnostic_updater._diagnostic_updater.CompositeDiagnosticTask
	tasks
Public Attributes inherited from diagnostic_updater._diagnostic_updater.DiagnosticTask
	name

Detailed Description

A class to facilitate making diagnostics for a topic using a
FrequencyStatus and TimeStampStatus.

Definition at line 79 of file _publisher.py.

Constructor & Destructor Documentation

def diagnostic_updater._publisher.TopicDiagnostic.__init__	(		self,
			name,
			diag,
			freq,
			stamp
	)

Constructs a TopicDiagnostic.

@param name The name of the topic that is being diagnosed.

@param diag The diagnostic_updater that the CompositeDiagnosticTask
should add itself to.

@param freq The parameters for the FrequencyStatus class that will be
computing statistics.

@param stamp The parameters for the TimeStampStatus class that will be
computing statistics.

Definition at line 84 of file _publisher.py.

Member Function Documentation

def diagnostic_updater._publisher.TopicDiagnostic.tick	(		self,
			stamp
	)

Collects statistics and publishes the message.

@param stamp Timestamp to use for interval computation by the
TimeStampStatus class.

Definition at line 103 of file _publisher.py.

Member Data Documentation

diagnostic_updater._publisher.TopicDiagnostic.stamp

Definition at line 100 of file _publisher.py.

---

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

• _publisher.py