GNU Radio's DVBS2RX Package
rotator_cc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2014 Free Software Foundation, Inc.
4 *
5 * SPDX-License-Identifier: GPL-3.0-or-later
6 */
7
8#ifndef INCLUDED_DVBS2RX_ROTATOR_CC_H
9#define INCLUDED_DVBS2RX_ROTATOR_CC_H
10
12#include <gnuradio/sync_block.h>
13
14namespace gr {
15namespace dvbs2rx {
16
17/*!
18 * \brief Complex rotator
19 * \ingroup math_operators_blk
20 *
21 * \details
22 *
23 * Rotates an input complex sequence using a complex exponential in the form of
24 * exp(1j * phase_inc * n), where "phase_inc" is a chosen phase increment in
25 * radians and "n" is the sample index.
26 *
27 * Message Ports:
28 *
29 * - cmd (input):
30 * Receives a PMT dictionary with a command message to set a new phase
31 * increment on the rotator at a specified sample offset. The new increment
32 * must be provided as a PMT double on a key named "inc". The target sample
33 * offset on which to update the phase increment must be given as a PMT
34 * uint64 (with the absolute output item number) on a key named
35 * "offset". Unlike the "inc" key, the "offset" key is optional. When not
36 * provided, the rotator updates its phase increment immediately.
37 */
38class DVBS2RX_API rotator_cc : virtual public sync_block
39{
40public:
41 // gr::blocks::rotator_cc::sptr
42 typedef std::shared_ptr<rotator_cc> sptr;
43
44 /*!
45 * \brief Make a complex rotator block
46 * \param phase_inc rotational velocity
47 * \param tag_inc_updates Tag the sample where a phase increment update is
48 * applied following the reception of a control
49 * message received via the input message port.
50 */
51 static sptr make(double phase_inc = 0.0, bool tag_inc_updates = false);
52
53 virtual void set_phase_inc(double phase_inc) = 0;
54};
55
56} // namespace dvbs2rx
57} // namespace gr
58
59#endif /* INCLUDED_DVBS2RX_ROTATOR_CC_H */
Complex rotator.
Definition rotator_cc.h:39
std::shared_ptr< rotator_cc > sptr
Definition rotator_cc.h:42
virtual void set_phase_inc(double phase_inc)=0
static sptr make(double phase_inc=0.0, bool tag_inc_updates=false)
Make a complex rotator block.
#define DVBS2RX_API
Definition include/gnuradio/dvbs2rx/api.h:19
Fixed-length double-ended queue with contiguous volk-aligned elements.
Definition gr_bch.h:22