Fawkes API  Fawkes Development Version
cascade.h
1 
2 /***************************************************************************
3  * cascade.h - Laser data filter cascade
4  *
5  * Created: Thu Jun 25 01:04:59 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 #ifndef __PLUGINS_LASER_FILTER_FILTERS_CASCADE_H_
24 #define __PLUGINS_LASER_FILTER_FILTERS_CASCADE_H_
25 
26 #include "filter.h"
27 
28 #include <list>
29 
31 {
32  public:
33  LaserDataFilterCascade(const std::string filter_name,
34  unsigned int in_data_size, std::vector<Buffer *> &in);
36 
37  virtual void set_out_vector(std::vector<LaserDataFilter::Buffer *> &out);
38 
40  void remove_filter(LaserDataFilter *filter);
41  void delete_filters();
42 
43  /** Check if filters have been added to the cascade.
44  * @return true if filters have been registered, false otherwise */
45  inline bool has_filters() const { return ! __filters.empty(); }
46 
47  void filter();
48 
49  /** Get filters.
50  * @return list of active filters. */
51  const std::list<LaserDataFilter *> & get_filters() const { return __filters; }
52 
53  private:
54  std::list<LaserDataFilter *> __filters;
55  std::list<LaserDataFilter *>::iterator __fit;
56 };
57 
58 
59 #endif
std::vector< Buffer * > out
Vector of output arrays.
Definition: filter.h:76
bool has_filters() const
Check if filters have been added to the cascade.
Definition: cascade.h:45
Cascade of several laser filters to one.
Definition: cascade.h:30
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
const std::list< LaserDataFilter * > & get_filters() const
Get filters.
Definition: cascade.h:51
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
const std::string filter_name
Name of the specific filter instance.
Definition: filter.h:72
~LaserDataFilterCascade()
Destructor.
Definition: cascade.cpp:48
void delete_filters()
Delete all filters.
Definition: cascade.cpp:92
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