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

Public Member Functions

def __init__ (self)
 
def has_filter (self)
 
def set_start_time (self, time)
 
def set_stop_time (self, time)
 
def set_stop_time_enabled (self, checked)
 
def test_message (self, message)
 

Private Attributes

 _start_time
 
 _stop_time
 
 _stop_time_enabled
 

Detailed Description

Contains filter logic for a time filter.
If _stop_time_enabled is true then the message's time value must be between the dates provided
to be considered a match
If _stop_time_enabled is false then the time must simply be after _start_time

Definition at line 37 of file time_filter.py.

Constructor & Destructor Documentation

def rqt_console.filters.time_filter.TimeFilter.__init__ (   self)

Definition at line 46 of file time_filter.py.

Member Function Documentation

def rqt_console.filters.time_filter.TimeFilter.has_filter (   self)

Definition at line 82 of file time_filter.py.

def rqt_console.filters.time_filter.TimeFilter.set_start_time (   self,
  time 
)
Setter for _start_time
:param time" start datetime for filter ''QDateTime''
:emits filter_changed_signal: If _enabled is true

Definition at line 52 of file time_filter.py.

def rqt_console.filters.time_filter.TimeFilter.set_stop_time (   self,
  time 
)
Setter for _stop_time
:param time" stop datetime for filter ''QDateTime''
:emits filter_changed_signal: If _enabled is true

Definition at line 62 of file time_filter.py.

def rqt_console.filters.time_filter.TimeFilter.set_stop_time_enabled (   self,
  checked 
)
Setter for _stop_time_enabled
:param checked" boolean flag to set ''bool''
:emits filter_changed_signal: If _enabled is true

Definition at line 72 of file time_filter.py.

def rqt_console.filters.time_filter.TimeFilter.test_message (   self,
  message 
)
Tests if the message matches the filter.
If _stop_time_enabled is true then the message's time value must be between the dates
provided to be considered a match
If _stop_time_enabled is false then the time must simply be after _start_time
:param message: the message to be tested against the filters, ''Message''
:returns: True if the message matches, ''bool''

Definition at line 85 of file time_filter.py.

Member Data Documentation

rqt_console.filters.time_filter.TimeFilter._start_time
private

Definition at line 48 of file time_filter.py.

rqt_console.filters.time_filter.TimeFilter._stop_time
private

Definition at line 49 of file time_filter.py.

rqt_console.filters.time_filter.TimeFilter._stop_time_enabled
private

Definition at line 50 of file time_filter.py.


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


rqt_console
Author(s): Aaron Blasdel
autogenerated on Sun May 24 2020 03:23:49