GNU Radio's GSM Package
decryption.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * @file
4  * @author (C) 2014 by Piotr Krysik <ptrkrysik@gmail.com>
5  * @section LICENSE
6  *
7  * Gr-gsm 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, or (at your option)
10  * any later version.
11  *
12  * Gr-gsm 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 gr-gsm; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23 
24 
25 #ifndef INCLUDED_GSM_DECRYPTION_H
26 #define INCLUDED_GSM_DECRYPTION_H
27 
28 #include <grgsm/api.h>
29 #include <gnuradio/block.h>
30 #include <vector>
31 
32 namespace gr {
33  namespace gsm {
34 
35  /*!
36  * \brief <+description of block+>
37  * \ingroup gsm
38  *
39  */
40  class GRGSM_API decryption : virtual public gr::block
41  {
42  public:
43  typedef boost::shared_ptr<decryption> sptr;
44 
45  /*!
46  * \brief Return a shared_ptr to a new instance of gsm::decryption.
47  *
48  * To avoid accidental use of raw pointers, gsm::decryption's
49  * constructor is in a private implementation
50  * class. gsm::decryption::make is the public interface for
51  * creating new instances.
52  */
53  static sptr make(const std::vector<uint8_t> & k_c, unsigned int a5_version);
54  virtual void set_k_c(const std::vector<uint8_t> & k_c) = 0;
55  virtual void set_a5_version(unsigned int a5_version) = 0;
56  };
57 
58  } // namespace gsm
59 } // namespace gr
60 
61 #endif /* INCLUDED_GSM_DECRYPTION_H */
62 
gr::gsm::decryption
<+description of block+>
Definition: decryption.h:41
gr::gsm::decryption::set_a5_version
virtual void set_a5_version(unsigned int a5_version)=0
gr::gsm::decryption::make
static sptr make(const std::vector< uint8_t > &k_c, unsigned int a5_version)
Return a shared_ptr to a new instance of gsm::decryption.
gr::gsm::decryption::set_k_c
virtual void set_k_c(const std::vector< uint8_t > &k_c)=0
gr
Definition: constants.h:29
GRGSM_API
#define GRGSM_API
Definition: api.h:31
gr::gsm::decryption::sptr
boost::shared_ptr< decryption > sptr
Definition: decryption.h:43
api.h