GNU Radio's GPS Package
gps_despread.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_GPS_GPS_DESPREAD_H
23 #define INCLUDED_GPS_GPS_DESPREAD_H
24 
25 #include <gps/api.h>
26 #include <gnuradio/block.h>
27 
28 namespace gr {
29  namespace gps {
30 
31  /*!
32  * \brief <+description of block+>
33  * \ingroup gps
34  *
35  */
36  class GPS_API gps_despread : virtual public gr::block
37  {
38  public:
39  typedef boost::shared_ptr<gps_despread> sptr;
40 
41 
42  virtual void set_delay(int) = 0;
43  virtual int delay() const = 0;
44  virtual int osr() const = 0;
45  virtual void set_osr(int) = 0;
46  virtual int code() const = 0;
47  virtual void set_code(int) = 0;
48 
49 
50  /*!
51  * \brief Return a shared_ptr to a new instance of gps::gps_despread.
52  *
53  * To avoid accidental use of raw pointers, gps::gps_despread's
54  * constructor is in a private implementation
55  * class. gps::gps_despread::make is the public interface for
56  * creating new instances.
57  */
58  static sptr make(int, int);
59  };
60 
61  } // namespace gps
62 } // namespace gr
63 
64 #endif /* INCLUDED_GPS_GPS_DESPREAD_H */
65 
boost::shared_ptr< gps_despread > sptr
Definition: gps_despread.h:39
#define GPS_API
Definition: api.h:30
<+description of block+>
Definition: gps_despread.h:36