GNU Radio's GFDM Package
frame_energy_detector_cc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2016 Johannes Demel.
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_FRAME_ENERGY_DETECTOR_CC_H
23#define INCLUDED_GFDM_FRAME_ENERGY_DETECTOR_CC_H
24
25#include <gfdm/api.h>
26#include <gnuradio/block.h>
27
28namespace gr {
29 namespace gfdm {
30
31 /*!
32 * \brief Detect frames based on energy ramp detection.
33 * \ingroup gfdm
34 *
35 */
36 class GFDM_API frame_energy_detector_cc : virtual public gr::block
37 {
38 public:
39 typedef boost::shared_ptr<frame_energy_detector_cc> sptr;
40
41 /*!
42 * \brief Return a shared_ptr to a new instance of gfdm::frame_energy_detector_cc.
43 *
44 * To avoid accidental use of raw pointers, gfdm::frame_energy_detector_cc's
45 * constructor is in a private implementation
46 * class. gfdm::frame_energy_detector_cc::make is the public interface for
47 * creating new instances.
48 */
49 static sptr make(float alpha, int average_len, int frame_len, int backoff_len, const std::string& tag_key);
50
51 virtual float alpha() = 0;
52 virtual void set_alpha(float alpha) = 0;
53 virtual int backoff_len() = 0;
54 virtual void set_backoff_len(int backoff_len) = 0;
55 };
56
57 } // namespace gfdm
58} // namespace gr
59
60#endif /* INCLUDED_GFDM_FRAME_ENERGY_DETECTOR_CC_H */
61
#define GFDM_API
Definition api.h:30
Detect frames based on energy ramp detection.
Definition frame_energy_detector_cc.h:37
virtual void set_backoff_len(int backoff_len)=0
boost::shared_ptr< frame_energy_detector_cc > sptr
Definition frame_energy_detector_cc.h:39
virtual void set_alpha(float alpha)=0
static sptr make(float alpha, int average_len, int frame_len, int backoff_len, const std::string &tag_key)
Return a shared_ptr to a new instance of gfdm::frame_energy_detector_cc.
Definition add_cyclic_prefix_cc.h:30