rqt_console.filters.message_filter.MessageFilter Class Reference

Inheritance diagram for rqt_console.filters.message_filter.MessageFilter:

Public Member Functions
def	__init__ (self)
def	has_filter (self)
def	set_regex (self, checked)
def	set_text (self, text)
def	test_message (self, message)

Private Member Functions
def	_test_message (self, value)

Private Attributes
	_regex
	_text

Detailed Description

Contains filter logic for a message filter. If the regex flag is False
simple 'is this in that' text matching is used on _text. If the regex flag is True
_text is treated as a regular expression with one exception. If it does not
start with a ^ a .* is appended, and if it does not end with a $ then a .*
is added to the end.
The filter_changed signal should be connected to a slot which notifies the
overall filtering system that it needs to reevaluate all entries.

Definition at line 37 of file message_filter.py.

Constructor & Destructor Documentation

def rqt_console.filters.message_filter.MessageFilter.__init__

(

self

)

Definition at line 49 of file message_filter.py.

Member Function Documentation

def rqt_console.filters.message_filter.MessageFilter._test_message (   self,   value  )

private

Definition at line 90 of file message_filter.py.

def rqt_console.filters.message_filter.MessageFilter.has_filter

(

self

)

Definition at line 74 of file message_filter.py.

def rqt_console.filters.message_filter.MessageFilter.set_regex	(		self,
			checked
	)

Setter for _regex
:param checked: boolean flag to set ''bool''
:emits filter_changed_signal: If _enabled is true

Definition at line 64 of file message_filter.py.

def rqt_console.filters.message_filter.MessageFilter.set_text	(		self,
			text
	)

Setter for _text
:param text: text to set ''str''
:emits filter_changed_signal: If _enabled is true

Definition at line 54 of file message_filter.py.

def rqt_console.filters.message_filter.MessageFilter.test_message	(		self,
			message
	)

Tests if the message matches the filter.
If the regex flag is False simple 'is this in that' text matching is used
on _text. If the regex flag is True _text is treated as a regular expression
with one exception. If it does not start with a ^ a .* is appended, and if
it does not end with a $ then a .* is added to the end.

:param message: the message to be tested against the filters, ''Message''
:returns: True if the message matches, ''bool''

Definition at line 77 of file message_filter.py.

Member Data Documentation

rqt_console.filters.message_filter.MessageFilter._regex

private

Definition at line 52 of file message_filter.py.

rqt_console.filters.message_filter.MessageFilter._text

private

Definition at line 51 of file message_filter.py.

---

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

• message_filter.py