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 | getName (self) |
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 :class:`FrequencyStatus` and :class:`TimeStampStatus`.
Definition at line 79 of file _publisher.py.
Constructor & Destructor Documentation
◆ __init__()
| def diagnostic_updater._publisher.TopicDiagnostic.__init__ | ( | self, | |
| name, | |||
| diag, | |||
| freq, | |||
| stamp | |||
| ) |
Constructs a :class:`TopicDiagnostic`.
: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.
:param diagnostic_updater.TimeStampStatusParam stamp: The parameters for the :class:`TimeStampStatus`
class that will be computing statistics.
Reimplemented in diagnostic_updater._publisher.DiagnosedPublisher.
Definition at line 84 of file _publisher.py.
Member Function Documentation
◆ tick()
| def diagnostic_updater._publisher.TopicDiagnostic.tick | ( | self, | |
| stamp | |||
| ) |
Collects statistics and publishes the message.
:param stamp: Timestamp to use for interval computation by the
:class:`TimeStampStatus` class.
:type stamp: float or rospy.Time
Definition at line 103 of file _publisher.py.
Member Data Documentation
◆ stamp
| diagnostic_updater._publisher.TopicDiagnostic.stamp |
Definition at line 100 of file _publisher.py.
The documentation for this class was generated from the following file: