GNU Radio's SATNOGS Package
iq_sink.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module
4  *
5  * Copyright (C) 2017, Libre Space Foundation <http://librespacefoundation.org/>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef INCLUDED_SATNOGS_IQ_SINK_H
22 #define INCLUDED_SATNOGS_IQ_SINK_H
23 
24 #include <satnogs/api.h>
25 #include <gnuradio/sync_block.h>
26 
27 namespace gr {
28 namespace satnogs {
29 
30 /*!
31  * \brief This block converts a complex float input stream to short and stores
32  * it to a file. If the value of status argument is zero the block behaves
33  * as a null sink block.
34  *
35  * \ingroup satnogs
36  *
37  */
38 class SATNOGS_API iq_sink : virtual public gr::sync_block {
39 public:
40  typedef boost::shared_ptr<iq_sink> sptr;
41 
42  /**
43  * This block converts a complex float input stream to short and stores
44  * it to a file. If the value of status argument is zero the block behaves
45  * as a null sink block.
46  *
47  * @param scale the value multiplied against each point in the input stream
48  * @param filename name of the file to open and write output to.
49  * @param append if true, data is appended to the file instead of
50  * overwriting the initial content.
51  * @param status the status of the block.
52  * - 0: Block acts as a null sink
53  * - 1: Active
54  *
55  * @return a shared_ptr to a new instance of satnogs::iq_sink.
56  */
57  static sptr make(const float scale,
58  const char *filename, bool append = false,
59  const int status = 0);
60 };
61 
62 }
63 // namespace satnogs
64 }// namespace gr
65 
66 #endif /* INCLUDED_SATNOGS_IQ_SINK_H */
67 
Definition: amsat_duv_decoder.h:29
boost::shared_ptr< iq_sink > sptr
Definition: iq_sink.h:40
#define SATNOGS_API
Definition: api.h:30
This block converts a complex float input stream to short and stores it to a file. If the value of status argument is zero the block behaves as a null sink block.
Definition: iq_sink.h:38