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 __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

 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 TopicDiagnostic combined with a ros::Publisher.

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

Definition at line 113 of file _publisher.py.

Constructor & Destructor Documentation

◆ __init__()

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

@param pub The publisher on which statistics are being collected.

@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 120 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 TimeStampStatus class will be
extracted from message.header.stamp.

Definition at line 137 of file _publisher.py.

Member Data Documentation

◆ publisher

diagnostic_updater._publisher.DiagnosedPublisher.publisher

Definition at line 135 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 Mon Feb 28 2022 22:18:16