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

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

Loading...
Searching...
No Matches
char_to_float.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2005,2012 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_BLOCKS_CHAR_TO_FLOAT_H
12#define INCLUDED_BLOCKS_CHAR_TO_FLOAT_H
13
14#include <gnuradio/blocks/api.h>
15#include <gnuradio/sync_block.h>
16
17namespace gr {
18namespace blocks {
19
20/*!
21 * \brief Convert stream of chars to a stream of float.
22 * \ingroup type_converters_blk
23 *
24 * \details
25 * Converts \p vlen length vectors of input char samples to floats
26 * and applies a scaling factor of \p scale:
27 *
28 * \li output[0][m:m+vlen] = static_cast<float>(input[0][m:m+vlen]) / scale
29 */
30 class BLOCKS_API char_to_float : virtual public sync_block
31{
32public:
33 // gr::blocks::char_to_float_ff::sptr
34 typedef std::shared_ptr<char_to_float> sptr;
35
36 /*!
37 * Build a chars to float stream converter block.
38 *
39 * \param vlen vector length of data streams.
40 * \param scale a scalar divider to change the output signal scale.
41 */
42 static sptr make(size_t vlen = 1, float scale = 1.0);
43
44 /*!
45 * Get the scalar divider value.
46 */
47 virtual float scale() const = 0;
48
49 /*!
50 * Set the scalar divider value.
51 */
52 virtual void set_scale(float scale) = 0;
53};
54
55} /* namespace blocks */
56} /* namespace gr */
57
58#endif /* INCLUDED_BLOCKS_CHAR_TO_FLOAT_H */
gr::blocks::char_to_float
Convert stream of chars to a stream of float.
Definition char_to_float.h:31
gr::blocks::char_to_float::make
static sptr make(size_t vlen=1, float scale=1.0)
gr::blocks::char_to_float::sptr
std::shared_ptr< char_to_float > sptr
Definition char_to_float.h:34
gr::blocks::char_to_float::scale
virtual float scale() const =0
gr::blocks::char_to_float::set_scale
virtual void set_scale(float scale)=0
gr::sync_block::sync_block
sync_block(void)
Definition sync_block.h:28
api.h
BLOCKS_API
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:18
gr::blocks
Definition abs_blk.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
sync_block.h