GNU Radio's GFDM Package
sync_cc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2016 Andrej Rode.
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_GFDM_SYNC_CC_H
23#define INCLUDED_GFDM_SYNC_CC_H
24
25#include <gfdm/api.h>
26#include <gnuradio/block.h>
28
29namespace gr {
30 namespace gfdm {
31
32 /*!
33 * \brief <+description of block+>
34 * \ingroup gfdm
35 *
36 */
37 class GFDM_API sync_cc : virtual public gr::block
38 {
39 public:
40 typedef boost::shared_ptr<sync_cc> sptr;
41
42 /*!
43 * \brief Return a shared_ptr to a new instance of gfdm::sync_cc.
44 *
45 * To avoid accidental use of raw pointers, gfdm::sync_cc's
46 * constructor is in a private implementation
47 * class. gfdm::sync_cc::make is the public interface for
48 * creating new instances.
49 */
50 static sptr make(int n_subcarriers, int cp_length, int frame_len, std::vector<gr_complex> preamble,
51 const std::string &gfdm_tag_key = "gfdm_block");
52 };
53
54 } // namespace gfdm
55} // namespace gr
56
57#endif /* INCLUDED_GFDM_SYNC_CC_H */
58
#define GFDM_API
Definition api.h:30
<+description of block+>
Definition sync_cc.h:38
boost::shared_ptr< sync_cc > sptr
Definition sync_cc.h:40
static sptr make(int n_subcarriers, int cp_length, int frame_len, std::vector< gr_complex > preamble, const std::string &gfdm_tag_key="gfdm_block")
Return a shared_ptr to a new instance of gfdm::sync_cc.
Definition add_cyclic_prefix_cc.h:30