Public Member Functions | Public Attributes | List of all members
diagnostic_updater._publisher.DiagnosedPublisher Class Reference
Inheritance diagram for diagnostic_updater._publisher.DiagnosedPublisher:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, pub, diag, freq, stamp)
 
def publish (self, message)
 
- Public Member Functions inherited from diagnostic_updater._publisher.TopicDiagnostic
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

 publisher
 
- Public Attributes inherited from diagnostic_updater._publisher.TopicDiagnostic
 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:`TopicDiagnostic` combined with a :class:`rospy.Publisher`.

For a standard :class:`rospy.Publisher`, this class allows the :class:`rospy.Publisher` and
the :class:`TopicDiagnostic` to be combined for added convenience.

Definition at line 114 of file _publisher.py.

Constructor & Destructor Documentation

◆ __init__()

def diagnostic_updater._publisher.DiagnosedPublisher.__init__ (   self,
  pub,
  diag,
  freq,
  stamp 
)
Constructs a :class:`DiagnosedPublisher`.

:param rospy.Publisher pub: The publisher on which statistics are being collected.

: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 from diagnostic_updater._publisher.TopicDiagnostic.

Definition at line 121 of file _publisher.py.

Member Function Documentation

◆ publish()

def diagnostic_updater._publisher.DiagnosedPublisher.publish (   self,
  message 
)
Collects statistics and publishes the message.

The timestamp to be used by the :class:`TimeStampStatus` class will be
extracted from `message.header.stamp`.

:param genpy.Message message: The message to be published.

Definition at line 138 of file _publisher.py.

Member Data Documentation

◆ publisher

diagnostic_updater._publisher.DiagnosedPublisher.publisher

Definition at line 136 of file _publisher.py.


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


diagnostic_updater
Author(s): Kevin Watts, Brice Rebsamen , Jeremy Leibs, Blaise Gassend
autogenerated on Tue May 6 2025 02:17:37