Public Member Functions | List of all members
rqt_bag.plugins.plugin.Plugin Class Reference
Inheritance diagram for rqt_bag.plugins.plugin.Plugin:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self)
 
def get_message_types (self)
 
def get_renderer_class (self)
 
def get_view_class (self)
 

Detailed Description

Interface for rqt_bag plugins.
User-defined plugins may either subclass `rqt_bag.plugin.Plugin` or according to duck typing implement only the needed methods.

Definition at line 34 of file plugin.py.

Constructor & Destructor Documentation

◆ __init__()

def rqt_bag.plugins.plugin.Plugin.__init__ (   self)

Definition at line 41 of file plugin.py.

Member Function Documentation

◆ get_message_types()

def rqt_bag.plugins.plugin.Plugin.get_message_types (   self)
Return  alist of message types which this plugin operates on.
To allow your plugin to be run on all message types return ['*'].

Definition at line 55 of file plugin.py.

◆ get_renderer_class()

def rqt_bag.plugins.plugin.Plugin.get_renderer_class (   self)
Return a class which is a child of rqt_bag.plugin.timeline_renderer.TimelineRenderer.
To omit the renderer component simply return None.

Definition at line 48 of file plugin.py.

◆ get_view_class()

def rqt_bag.plugins.plugin.Plugin.get_view_class (   self)
Return a class which is a child of rqt_bag.plugin.topic_message_view.TopicMessageView.

Definition at line 44 of file plugin.py.


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


rqt_bag
Author(s): Dirk Thomas , Aaron Blasdel , Austin Hendrix , Tim Field
autogenerated on Fri Mar 3 2023 03:45:54