diagnostic_updater._publisher.HeaderlessTopicDiagnostic Class Reference

Inheritance diagram for diagnostic_updater._publisher.HeaderlessTopicDiagnostic:

Public Member Functions
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
	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.

The word "headerless" in the class name refers to the fact that it is
mainly designed for use with messages that do not have a header, and
that cannot therefore be checked using a TimeStampStatus.

Definition at line 44 of file _publisher.py.

Constructor & Destructor Documentation

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

Constructs a HeaderlessTopicDiagnostic.

@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.

Definition at line 53 of file _publisher.py.

Member Function Documentation

def diagnostic_updater._publisher.HeaderlessTopicDiagnostic.clear_window

(

self

)

Clears the frequency statistics.

Definition at line 74 of file _publisher.py.

def diagnostic_updater._publisher.HeaderlessTopicDiagnostic.tick

(

self

)

Signals that a publication has occurred.

Definition at line 70 of file _publisher.py.

Member Data Documentation

diagnostic_updater._publisher.HeaderlessTopicDiagnostic.diag

Definition at line 65 of file _publisher.py.

diagnostic_updater._publisher.HeaderlessTopicDiagnostic.freq

Definition at line 66 of file _publisher.py.

---

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

• _publisher.py