GNU Radio Radar Toolbox
signal_generator_fsk_c.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 #ifndef INCLUDED_RADAR_SIGNAL_GENERATOR_FSK_C_H
22 #define INCLUDED_RADAR_SIGNAL_GENERATOR_FSK_C_H
23 
24 #include <gnuradio/sync_block.h>
25 #include <radar/api.h>
26 
27 namespace gr {
28 namespace radar {
29 
30 /*!
31  * \brief This block generates a signal for FSK radar in baseband. The waveform consists
32  * of a signal with an alternating frequency. The packet length for subsequent tagged
33  * streams is calculated with two times the samples per single frequency multiplied by the
34  * blocks per tag.
35  *
36  * \param samp_rate Signal sample rate
37  * \param samp_per_freq Number of samples per frequency until the frequency shifts
38  * \param blocks_per_tag A block contains samp_per_freq samples of the low frequency and
39  * samp_per_freq samples of the high frequency. The packet length for subsequent tagged
40  * stream blocks is calculated with 2*samp_per_freq*blocks_per_tag. \param freq_low Lower
41  * frequency in baseband \param freq_high Higher frequency in baseband \param amplitude
42  * Signal amplitude \param len_key Packet length key for tagged stream
43  *
44  * \ingroup radar
45  *
46  */
47 class RADAR_API signal_generator_fsk_c : virtual public gr::sync_block
48 {
49 public:
50  typedef boost::shared_ptr<signal_generator_fsk_c> sptr;
51 
52  /*!
53  * \brief Return a shared_ptr to a new instance of radar::signal_generator_fsk_c.
54  *
55  * To avoid accidental use of raw pointers, radar::signal_generator_fsk_c's
56  * constructor is in a private implementation
57  * class. radar::signal_generator_fsk_c::make is the public interface for
58  * creating new instances.
59  */
60  static sptr make(int samp_rate,
61  int samp_per_freq,
62  int blocks_per_tag,
63  float freq_low,
64  float freq_high,
65  float amplitude,
66  const std::string& len_key = "packet_len");
67 };
68 
69 } // namespace radar
70 } // namespace gr
71 
72 #endif /* INCLUDED_RADAR_SIGNAL_GENERATOR_FSK_C_H */
RADAR_API
#define RADAR_API
Definition: api.h:31
gr::radar::signal_generator_fsk_c::sptr
boost::shared_ptr< signal_generator_fsk_c > sptr
Definition: signal_generator_fsk_c.h:50
gr::radar::signal_generator_fsk_c
This block generates a signal for FSK radar in baseband. The waveform consists of a signal with an al...
Definition: signal_generator_fsk_c.h:48
gr
Definition: crop_matrix_vcvc.h:28
gr::radar::signal_generator_fsk_c::make
static sptr make(int samp_rate, int samp_per_freq, int blocks_per_tag, float freq_low, float freq_high, float amplitude, const std::string &len_key="packet_len")
Return a shared_ptr to a new instance of radar::signal_generator_fsk_c.
api.h