Public Member Functions | Static Public Attributes | Private Attributes | List of all members
rqt_console.filters.base_filter.BaseFilter Class Reference
Inheritance diagram for rqt_console.filters.base_filter.BaseFilter:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self)
 
def has_filter (self)
 
def is_enabled (self)
 
def set_enabled (self, checked)
 
def start_emit_timer (self, msec=None)
 
def test_message (self, message)
 

Static Public Attributes

 filter_changed_signal = Signal()
 

Private Attributes

 _enabled
 
 _timer
 

Detailed Description

Contains basic functions common to all filters.
Handles enabled logic and change notification.

Definition at line 36 of file base_filter.py.

Constructor & Destructor Documentation

◆ __init__()

def rqt_console.filters.base_filter.BaseFilter.__init__ (   self)

Member Function Documentation

◆ has_filter()

def rqt_console.filters.base_filter.BaseFilter.has_filter (   self)

◆ is_enabled()

def rqt_console.filters.base_filter.BaseFilter.is_enabled (   self)

Definition at line 62 of file base_filter.py.

◆ set_enabled()

def rqt_console.filters.base_filter.BaseFilter.set_enabled (   self,
  checked 
)
Setter for _enabled
:param checked: boolean flag to set ''bool''
:emits filter_changed_signal: Always

Reimplemented in rqt_console.filters.custom_filter.CustomFilter.

Definition at line 65 of file base_filter.py.

◆ start_emit_timer()

def rqt_console.filters.base_filter.BaseFilter.start_emit_timer (   self,
  msec = None 
)
Starts a timer to emit a signal to refresh the filters after the filter is changed
:param msec: number of msecs to wait before emitting the signal to change the filter ''int''

Definition at line 52 of file base_filter.py.

◆ test_message()

def rqt_console.filters.base_filter.BaseFilter.test_message (   self,
  message 
)

Member Data Documentation

◆ _enabled

rqt_console.filters.base_filter.BaseFilter._enabled
private

Definition at line 46 of file base_filter.py.

◆ _timer

rqt_console.filters.base_filter.BaseFilter._timer
private

Definition at line 48 of file base_filter.py.

◆ filter_changed_signal

rqt_console.filters.base_filter.BaseFilter.filter_changed_signal = Signal()
static

Definition at line 42 of file base_filter.py.


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


rqt_console
Author(s): Aaron Blasdel
autogenerated on Sun Oct 15 2023 02:24:45