GNU Radio Manual and C++ API Reference 3.8.5.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 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_BLOCKS_CHAR_TO_FLOAT_H
24#define INCLUDED_BLOCKS_CHAR_TO_FLOAT_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief Convert stream of chars to a stream of float.
34 * \ingroup type_converters_blk
35 *
36 * \details
37 * Converts \p vlen length vectors of input char samples to floats
38 * and applies a scaling factor of \p scale:
39 *
40 * \li output[0][m:m+vlen] = static_cast<float>(input[0][m:m+vlen]) / scale
41 */
42class BLOCKS_API char_to_float : virtual public sync_block
43{
44public:
45 // gr::blocks::char_to_float_ff::sptr
46 typedef boost::shared_ptr<char_to_float> sptr;
47
48 /*!
49 * Build a chars to float stream converter block.
50 *
51 * \param vlen vector length of data streams.
52 * \param scale a scalar divider to change the output signal scale.
53 */
54 static sptr make(size_t vlen = 1, float scale = 1.0);
55
56 /*!
57 * Get the scalar divider value.
58 */
59 virtual float scale() const = 0;
60
61 /*!
62 * Set the scalar divider value.
63 */
64 virtual void set_scale(float scale) = 0;
65};
66
67} /* namespace blocks */
68} /* namespace gr */
69
70#endif /* INCLUDED_BLOCKS_CHAR_TO_FLOAT_H */
Convert stream of chars to a stream of float.
Definition char_to_float.h:43
static sptr make(size_t vlen=1, float scale=1.0)
virtual float scale() const =0
boost::shared_ptr< char_to_float > sptr
Definition char_to_float.h:46
virtual void set_scale(float scale)=0
synchronous 1:1 input to output with history
Definition sync_block.h:38
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46