Fawkes API  Fawkes Development Version
cascade.cpp
1 
2 /***************************************************************************
3  * cascade.cpp - Laser data filter cascade
4  *
5  * Created: Thu Jun 25 01:07:53 2009
6  * Copyright 2006-2009 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU Library General Public License for more details.
19  *
20  * Read the full text in the LICENSE.GPL file in the doc directory.
21  */
22 
23 #include "cascade.h"
24 
25 /** @class LaserDataFilterCascade "filters/cascade.h"
26  * Cascade of several laser filters to one.
27  * The filters are executed in the order they are added to the cascade.
28  * @author Tim Niemueller
29  */
30 
31 /** Constructor.
32  * @param filter_name name of this filter combo
33  * @param in_data_size number of entries input value arrays
34  * @param in vector of input arrays
35  */
36 LaserDataFilterCascade::LaserDataFilterCascade(const std::string filter_name,
37  unsigned int in_data_size,
38  std::vector<Buffer *> &in)
39  : LaserDataFilter(filter_name, in_data_size, in, 0)
40 {
42  out = in;
43  set_array_ownership(false, false);
44 }
45 
46 
47 /** Destructor. */
49 {
51 }
52 
53 
54 /** Set filtered data array
55  * @param out vector of output values. The vector is only accepted if it has
56  * the same size as the current one. The filter will now longer assume
57  * ownership of the arrays in the vector. Either free the memory or call
58  * set_array_ownership().
59  */
60 void
61 LaserDataFilterCascade::set_out_vector(std::vector<LaserDataFilter::Buffer *> &out)
62 {
63  __filters.back()->set_out_vector(out);
64  this->out = __filters.back()->get_out_vector();
65 }
66 
67 
68 /** Add a filter to the cascade.
69  * @param filter filter to add
70  */
71 void
73 {
74  __filters.push_back(filter);
75  out_data_size = filter->get_out_data_size();
76  out = filter->get_out_vector();
77 }
78 
79 
80 /** Remove a filter from the cascade.
81  * @param filter filter to remove
82  */
83 void
85 {
86  __filters.remove(filter);
87 }
88 
89 
90 /** Delete all filters. */
91 void
93 {
94  for (__fit = __filters.begin(); __fit != __filters.end(); ++__fit) {
95  delete *__fit;
96  }
97  __filters.clear();
98 }
99 
100 
101 void
103 {
104  for (__fit = __filters.begin(); __fit != __filters.end(); ++__fit) {
105  (*__fit)->filter();
106  }
107 }
void set_array_ownership(bool own_in, bool own_out)
Set input/output array ownership.
Definition: filter.cpp:216
std::vector< Buffer * > out
Vector of output arrays.
Definition: filter.h:76
virtual unsigned int get_out_data_size()
Get size of filtered data array.
Definition: filter.cpp:176
void remove_filter(LaserDataFilter *filter)
Remove a filter from the cascade.
Definition: cascade.cpp:84
LaserDataFilterCascade(const std::string filter_name, unsigned int in_data_size, std::vector< Buffer *> &in)
Constructor.
Definition: cascade.cpp:36
virtual void set_out_vector(std::vector< LaserDataFilter::Buffer *> &out)
Set filtered data array.
Definition: cascade.cpp:61
void filter()
Filter the incoming data.
Definition: cascade.cpp:102
void add_filter(LaserDataFilter *filter)
Add a filter to the cascade.
Definition: cascade.cpp:72
unsigned int out_data_size
Number of entries in output arrays.
Definition: filter.h:73
~LaserDataFilterCascade()
Destructor.
Definition: cascade.cpp:48
void delete_filters()
Delete all filters.
Definition: cascade.cpp:92
virtual std::vector< Buffer * > & get_out_vector()
Get filtered data array.
Definition: filter.cpp:116
std::vector< Buffer * > in
Vector of input arrays.
Definition: filter.h:75
unsigned int in_data_size
Number of entries in input arrays.
Definition: filter.h:74
Laser data filter.
Definition: filter.h:32