GNU Radio Radar Toolbox
trigger_command.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_TRIGGER_COMMAND_H
23 #define INCLUDED_RADAR_TRIGGER_COMMAND_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 executes a command with the std::system() command if a value from a
33  * f32vector with a given identifer (symbol) is in a given range. Each index of a vector
34  * refers to a identifier. The execution of a command can be blocked for block_time
35  * milliseconds after the last execution.
36  *
37  * \param command Command string
38  * \param identifiers Identifiers (symbols) as vector of strings
39  * \param vals_min Minimum values as f32vector
40  * \param vals_max Maximum values as f32vector
41  * \param block_time Block executing commands for block_time milliseconds
42  *
43  * \ingroup radar
44  *
45  */
46 class RADAR_API trigger_command : virtual public gr::block
47 {
48 public:
49  typedef boost::shared_ptr<trigger_command> sptr;
50 
51  /*!
52  * \brief Return a shared_ptr to a new instance of radar::trigger_command.
53  *
54  * To avoid accidental use of raw pointers, radar::trigger_command's
55  * constructor is in a private implementation
56  * class. radar::trigger_command::make is the public interface for
57  * creating new instances.
58  */
59  static sptr make(std::string command,
60  std::vector<std::string> identifiers,
61  std::vector<float> vals_min,
62  std::vector<float> vals_max,
63  int block_time);
64 };
65 
66 } // namespace radar
67 } // namespace gr
68 
69 #endif /* INCLUDED_RADAR_TRIGGER_COMMAND_H */
This block executes a command with the std::system() command if a value from a f32vector with a given...
Definition: trigger_command.h:46
Definition: crop_matrix_vcvc.h:28
boost::shared_ptr< trigger_command > sptr
Definition: trigger_command.h:49
#define RADAR_API
Definition: api.h:31