GNU Radio's AIS Package
pdu_to_nmea.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2014 <+YOU OR YOUR COMPANY+>.
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_AIS_PDU_TO_NMEA_H
23 #define INCLUDED_AIS_PDU_TO_NMEA_H
24 
25 #include <ais/api.h>
26 #include <gnuradio/block.h>
27 
28 namespace gr {
29  namespace ais {
30 
31  /*!
32  * \brief <+description of block+>
33  * \ingroup ais
34  *
35  */
36  class AIS_API pdu_to_nmea : virtual public gr::block
37  {
38  public:
39  typedef boost::shared_ptr<pdu_to_nmea> sptr;
40 
41  virtual void to_nmea(pmt::pmt_t) = 0;
42  virtual void print(pmt::pmt_t) = 0;
43 
44  /*!
45  * \brief Return a shared_ptr to a new instance of ais::pdu_to_nmea.
46  *
47  * To avoid accidental use of raw pointers, ais::pdu_to_nmea's
48  * constructor is in a private implementation
49  * class. ais::pdu_to_nmea::make is the public interface for
50  * creating new instances.
51  */
52  static sptr make(std::string designator);
53  };
54 
55  } // namespace ais
56 } // namespace gr
57 
58 #endif /* INCLUDED_AIS_PDU_TO_NMEA_H */
59 
#define AIS_API
Definition: api.h:30
<+description of block+>
Definition: pdu_to_nmea.h:36
boost::shared_ptr< pdu_to_nmea > sptr
Definition: pdu_to_nmea.h:39