Loading...
Searching...
No Matches
rotator_cc.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2014 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_BLOCKS_ROTATOR_CC_H
#define INCLUDED_BLOCKS_ROTATOR_CC_H
#include <gnuradio/blocks/api.h>
#include <gnuradio/sync_block.h>
namespace gr {
namespace blocks {
/*!
* \brief Complex rotator
* \ingroup math_operators_blk
*
* \details
*
* Rotates an input complex sequence using a complex exponential in the form of
* exp(1j * phase_inc * n), where "phase_inc" is a chosen phase increment in
* radians and "n" is the sample index.
*
* Message Ports:
*
* - cmd (input):
* Receives a PMT dictionary with a command message to set a new phase
* increment on the rotator at a specified sample offset. The new increment
* must be provided as a PMT double on a key named "inc". The target sample
* offset on which to update the phase increment must be given as a PMT
* uint64 (with the absolute output item number) on a key named
* "offset". Unlike the "inc" key, the "offset" key is optional. When not
* provided, the rotator updates its phase increment immediately.
*/
class BLOCKS_API rotator_cc : virtual public sync_block
{
public:
// gr::blocks::rotator_cc::sptr
typedef std::shared_ptr<rotator_cc> sptr;
/*!
* \brief Make a complex rotator block
* \param phase_inc rotational velocity
* \param tag_inc_updates Tag the sample where a phase increment update is
* applied following the reception of a control
* message received via the input message port.
*/
static sptr make(double phase_inc = 0.0, bool tag_inc_updates = false);
virtual void set_phase_inc(double phase_inc) = 0;
};
} /* namespace blocks */
} /* namespace gr */
#endif /* INCLUDED_BLOCKS_ROTATOR_CC_H */
gr::blocks::rotator_cc
Complex rotator.
Definition rotator_cc.h:42
gr::blocks::rotator_cc::make
static sptr make(double phase_inc=0.0, bool tag_inc_updates=false)
Make a complex rotator block.
gr::blocks::rotator_cc::sptr
std::shared_ptr< rotator_cc > sptr
Definition rotator_cc.h:45
gr::blocks::rotator_cc::set_phase_inc
virtual void set_phase_inc(double phase_inc)=0
gr::sync_block
synchronous 1:1 input to output with history
Definition sync_block.h:26
api.h
BLOCKS_API
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h