Inheritance diagram for diagnostic_updater._publisher.HeaderlessTopicDiagnostic:

[legend]

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	getName (self)

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
:class:`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 :class:`TimeStampStatus`.

Definition at line 44 of file _publisher.py.

Constructor & Destructor Documentation

◆ init()

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

Constructs a :class:`HeaderlessTopicDiagnostic`.

:param str name: The name of the topic that is being diagnosed.

:param diagnostic_updater.Updater diag: The :class:`Updater` that the :class:`CompositeDiagnosticTask`
                                should add itself to.

:param diagnostic_updater.FrequencyStatusParam freq: The parameters for the :class:`FrequencyStatus`
                                             class that will be computing statistics.

Definition at line 53 of file _publisher.py.

Member Function Documentation

◆ clear_window()

def diagnostic_updater._publisher.HeaderlessTopicDiagnostic.clear_window ( self )

Clears the frequency statistics.

Definition at line 74 of file _publisher.py.

◆ tick()

def diagnostic_updater._publisher.HeaderlessTopicDiagnostic.tick ( self )

Signals that a publication has occurred.

Definition at line 70 of file _publisher.py.

Member Data Documentation

◆ diag

diagnostic_updater._publisher.HeaderlessTopicDiagnostic.diag

Definition at line 65 of file _publisher.py.

◆ freq

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

Public Member Functions

Public Attributes