GNU Radio's GSM Package
message_file_sink.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /* @file
3  * @author (C) 2015 by Roman Khassraf <rkhassraf@gmail.com>
4  * @section LICENSE
5  *
6  * Gr-gsm is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3, or (at your option)
9  * any later version.
10  *
11  * Gr-gsm is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with gr-gsm; see the file COPYING. If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22 
23 #ifndef INCLUDED_GSM_MESSAGE_FILE_SINK_H
24 #define INCLUDED_GSM_MESSAGE_FILE_SINK_H
25 
26 #include <grgsm/api.h>
27 #include <gnuradio/block.h>
28 
29 namespace gr {
30  namespace gsm {
31 
32  /*!
33  * \brief <+description of block+>
34  * \ingroup gsm
35  *
36  */
37  class GRGSM_API message_file_sink : virtual public gr::block
38  {
39  public:
40  typedef boost::shared_ptr<message_file_sink> sptr;
41 
42  /*!
43  * \brief Return a shared_ptr to a new instance of grgsm::message_file_sink.
44  *
45  * To avoid accidental use of raw pointers, grgsm::message_file_sink's
46  * constructor is in a private implementation
47  * class. grgsm::message_file_sink::make is the public interface for
48  * creating new instances.
49  */
50  static sptr make(const std::string &filename);
51  };
52  } // namespace gsm
53 } // namespace gr
54 
55 #endif /* INCLUDED_GSM_MESSAGE_FILE_SINK_H */
56 
gr::gsm::message_file_sink
<+description of block+>
Definition: message_file_sink.h:38
gr
Definition: constants.h:29
GRGSM_API
#define GRGSM_API
Definition: api.h:31
gr::gsm::message_file_sink::make
static sptr make(const std::string &filename)
Return a shared_ptr to a new instance of grgsm::message_file_sink.
gr::gsm::message_file_sink::sptr
boost::shared_ptr< message_file_sink > sptr
Definition: message_file_sink.h:40
api.h