RSB  0.17.0
CauseFilter.h
Go to the documentation of this file.
1 /* ============================================================
2  *
3  * This file is part of the RSB project.
4  *
5  * Copyright (C) 2016 Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
6  *
7  * This file may be licensed under the terms of the
8  * GNU Lesser General Public License Version 3 (the ``LGPL''),
9  * or (at your option) any later version.
10  *
11  * Software distributed under the License is distributed
12  * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
13  * express or implied. See the LGPL for the specific language
14  * governing rights and limitations.
15  *
16  * You should have received a copy of the LGPL along with this
17  * program. If not, go to http://www.gnu.org/licenses/lgpl.html
18  * or write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The development of this software was supported by:
22  * CoR-Lab, Research Institute for Cognition and Robotics
23  * Bielefeld University
24  *
25  * ============================================================ */
26 
27 #pragma once
28 
29 #include <rsc/misc/UUID.h>
30 
31 #include <rsb/EventId.h>
32 
33 #include "Filter.h"
34 
35 #include "rsb/rsbexports.h"
36 
37 namespace rsb {
38 namespace filter {
39 
45 class RSB_EXPORT CauseFilter: public Filter {
46 public:
56  CauseFilter(const rsc::misc::UUID& cause,
57  bool invert = false);
58 
68  CauseFilter(const EventId& cause,
69  bool invert = false);
70 
78  rsc::misc::UUID getCause() const;
79 
85  bool isInverted() const;
86 
87  bool match(EventPtr e);
88 
89  void notifyObserver(FilterObserverPtr fo, FilterAction::Types at);
90 private:
92  rsc::misc::UUID causeAsUUID;
93  bool invert;
94 };
95 
96 }
97 }
A filter filters an event stream by removing unwanted events.
Definition: Filter.h:56
rsc::misc::UUID causeAsUUID
Definition: CauseFilter.h:92
Types
Possible actions with filters.
boost::shared_ptr< FilterObserver > FilterObserverPtr
Definition: Filter.h:38
This filter matches events in which a particular cause is present.
Definition: CauseFilter.h:45
boost::shared_ptr< EventId > EventIdPtr
Definition: EventId.h:82
A unique ID for events in RSB.
Definition: EventId.h:48
boost::shared_ptr< Event > EventPtr
Definition: Event.h:264