user_filter.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * fkie_message_filters
4  * Copyright © 2018-2020 Fraunhofer FKIE
5  * Author: Timo Röhling
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  ****************************************************************************/
20 #ifndef INCLUDE_FKIE_MESSAGE_FILTERS_USER_FILTER_H_
21 #define INCLUDE_FKIE_MESSAGE_FILTERS_USER_FILTER_H_
22 
23 #include "filter.h"
24 #include <functional>
25 
26 namespace fkie_message_filters
27 {
28 
29 #ifndef DOXYGEN
30 template<class In, class Out>
31 class UserFilter;
32 #endif
33 
76 #ifndef DOXYGEN
77 template<class... Inputs, class... Outputs>
78 class UserFilter<IO<Inputs...>, IO<Outputs...>> : public Filter<IO<Inputs...>, IO<Outputs...>>
79 #else
80 template<class... Inputs, class... Outputs>
81 class UserFilter : public Filter<IO<Inputs...>, IO<Outputs...>>
82 #endif
83 {
84 public:
89  using CallbackFunction = FilterCB<Outputs...>;
95  using ProcessingFunction = std::function<void(const Inputs&..., const CallbackFunction&)>;
102  void set_processing_function (const ProcessingFunction& f) noexcept;
103 protected:
104  void receive (const Inputs&... in) override;
105 private:
107 };
108 
109 } // namespace fkie_message_filters
110 
111 #include "user_filter_impl.h"
112 
113 #endif /* INCLUDE_FKIE_MESSAGE_FILTERS_USER_FILTER_H_ */
typename helpers::FilterCB< Types... >::Type FilterCB
Callback function for customizable filters.
Definition: filter_base.h:50
Group multiple data types as filter input or output.
Definition: io.h:27
Typed base class for filters.
Definition: filter.h:35
Primary namespace.
Definition: buffer.h:33
FilterCB< Outputs... > CallbackFunction
Callback function type.
Definition: user_filter.h:89
string template
std::function< void(const Inputs &..., const CallbackFunction &)> ProcessingFunction
Processing function type.
Definition: user_filter.h:95


fkie_message_filters
Author(s): Timo Röhling
autogenerated on Sun Sep 12 2021 02:52:12