GNU Radio C++ API Reference: constellation_encoder_bc.h Source File

| GNU Radio C++ API Reference 3.10.12.0 The Free & Open Software Radio Ecosystem |

Loading...
Searching...
No Matches
constellation_encoder_bc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2020 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * SPDX-License-Identifier: GPL-3.0-or-later
8 *
9 */
10
11#ifndef INCLUDED_DIGITAL_CONSTELLATION_ENCODER_BC_H
12#define INCLUDED_DIGITAL_CONSTELLATION_ENCODER_BC_H
13
14#include <gnuradio/digital/api.h>
15#include <gnuradio/digital/constellation.h>
16#include <gnuradio/sync_interpolator.h>
17
18namespace gr {
19namespace digital {
20
21/*!
22 * \brief Constellation Encoder
23 * \ingroup symbol_coding_blk
24 *
25 * \details
26 * Encode index of constellation points into a constellation's complex
27 * space based on the map of the \p constellation object.
28 */
29 class DIGITAL_API constellation_encoder_bc : virtual public sync_interpolator
30{
31public:
32 // gr::digital::constellation_encoder_bc::sptr
33 typedef std::shared_ptr<constellation_encoder_bc> sptr;
34
35 /*!
36 * \brief Make constellation encoder block.
37 *
38 * \param constellation A constellation derived from class
39 * 'constellation'. Use base() method to get a shared pointer to
40 * this base class type.
41 */
42 static sptr make(constellation_sptr constellation);
43
44 /*!
45 * Set a new constellation object for encoding
46 *
47 * \param constellation A constellation derived from class
48 * 'constellation'. Use base() method to get a shared pointer to
49 * this base class type.
50 */
51 virtual void set_constellation(constellation_sptr constellation) = 0;
52};
53
54} /* namespace digital */
55} /* namespace gr */
56
57#endif /* INCLUDED_DIGITAL_CONSTELLATION_ENCODER_BC_H */
gr::digital::constellation_encoder_bc
Constellation Encoder.
Definition constellation_encoder_bc.h:30
gr::digital::constellation_encoder_bc::set_constellation
virtual void set_constellation(constellation_sptr constellation)=0
gr::digital::constellation_encoder_bc::sptr
std::shared_ptr< constellation_encoder_bc > sptr
Definition constellation_encoder_bc.h:33
gr::digital::constellation_encoder_bc::make
static sptr make(constellation_sptr constellation)
Make constellation encoder block.
gr::digital::constellation
An abstracted constellation object.
Definition constellation.h:50
gr::sync_interpolator::sync_interpolator
sync_interpolator(void)
Definition sync_interpolator.h:31
constellation.h
api.h
DIGITAL_API
#define DIGITAL_API
Definition gr-digital/include/gnuradio/digital/api.h:18
gr::digital
Definition adaptive_algorithm.h:22
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_interpolator.h