GNU Radio Radar Toolbox
msg_gate.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2014 Communications Engineering Lab, KIT.
4  *
5  * This is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3, or (at your option)
8  * any later version.
9  *
10  * This software is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this software; see the file COPYING. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street,
18  * Boston, MA 02110-1301, USA.
19  */
20 
21 
22 #ifndef INCLUDED_RADAR_MSG_GATE_H
23 #define INCLUDED_RADAR_MSG_GATE_H
24 
25 #include <gnuradio/block.h>
26 #include <radar/api.h>
27 
28 namespace gr {
29 namespace radar {
30 
31 /*!
32  * \brief This block blocks messages whose data is not in range of val_min to val_max. All
33  * parameters are given as vectors. Each index represents a dataset with given identifier
34  * (symbol) which should be tested on valid data in given range. All other data is pushed
35  * through.
36  *
37  * \param keys Identifiers (symbols) of the data as vector
38  * \param val_min Lower limit of the gate as vector
39  * \param val_max Higher limit of the gate as vector
40  *
41  * \ingroup radar
42  *
43  */
44 class RADAR_API msg_gate : virtual public gr::block
45 {
46 public:
47  typedef boost::shared_ptr<msg_gate> sptr;
48 
49  /*!
50  * \brief Return a shared_ptr to a new instance of radar::msg_gate.
51  *
52  * To avoid accidental use of raw pointers, radar::msg_gate's
53  * constructor is in a private implementation
54  * class. radar::msg_gate::make is the public interface for
55  * creating new instances.
56  */
57  static sptr make(std::vector<std::string> keys,
58  std::vector<float> val_min,
59  std::vector<float> val_max);
60 };
61 
62 } // namespace radar
63 } // namespace gr
64 
65 #endif /* INCLUDED_RADAR_MSG_GATE_H */
gr::radar::msg_gate::make
static sptr make(std::vector< std::string > keys, std::vector< float > val_min, std::vector< float > val_max)
Return a shared_ptr to a new instance of radar::msg_gate.
RADAR_API
#define RADAR_API
Definition: api.h:31
gr::radar::msg_gate::sptr
boost::shared_ptr< msg_gate > sptr
Definition: msg_gate.h:47
gr::radar::msg_gate
This block blocks messages whose data is not in range of val_min to val_max. All parameters are given...
Definition: msg_gate.h:45
gr
Definition: crop_matrix_vcvc.h:28
api.h