rqt_console.filters.filter_collection.FilterCollection Class Reference

List of all members.

Public Member Functions
def	__delitem__
def	__init__
def	__len__
def	append
def	count
def	count_enabled_filters
def	test_message
def	test_message_array
Private Attributes
	_filters
	_proxymodel

---

Detailed Description

This class provides an interface to filter Message objects based on
of a set of filters which will be boolean combined with either 'or'
or 'and' based on the combination type passed by the user.
''True'' for and combine and ''False'' for or combine

Definition at line 36 of file filter_collection.py.

---

Constructor & Destructor Documentation

def rqt_console.filters.filter_collection.FilterCollection.__init__	(		self,
			proxymodel
	)

:param proxymodel: , ''QSortFilterProxyModel''

Definition at line 43 of file filter_collection.py.

---

Member Function Documentation

def rqt_console.filters.filter_collection.FilterCollection.__delitem__	(		self,
			index
	)

Definition at line 94 of file filter_collection.py.

def rqt_console.filters.filter_collection.FilterCollection.__len__

(

self

)

Definition at line 88 of file filter_collection.py.

def rqt_console.filters.filter_collection.FilterCollection.append	(		self,
			newfilter
	)

Adds a new filter to the filter list and returns the index
:returns: The index of the filter appended, ''int''

Definition at line 74 of file filter_collection.py.

def rqt_console.filters.filter_collection.FilterCollection.count

(

self

)

Definition at line 91 of file filter_collection.py.

def rqt_console.filters.filter_collection.FilterCollection.count_enabled_filters

(

self

)

Definition at line 81 of file filter_collection.py.

def rqt_console.filters.filter_collection.FilterCollection.test_message	(		self,
			message
	)

Tests if the message matches the entire list of filters.
if passed an array of the 6 data elements of a message it will build one
:param message: message to be tested against the filters, ''Message''
:returns: True if the message matches the filters, ''bool''

Definition at line 62 of file filter_collection.py.

def rqt_console.filters.filter_collection.FilterCollection.test_message_array	(		self,
			message
	)

test_message function for an array formatted message
:param message: array of the message member data in order ''list'':
        message text ''str'', severity ''str'', node ''str'',
        time in seconds with decimals ''str'', topic ''str'',

Definition at line 50 of file filter_collection.py.

---

Member Data Documentation

rqt_console::filters::filter_collection.FilterCollection::_filters [private]

Definition at line 45 of file filter_collection.py.

rqt_console::filters::filter_collection.FilterCollection::_proxymodel [private]

Definition at line 45 of file filter_collection.py.

---

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

• filter_collection.py