GNU Radio 3.6.5 C++ API

gr_float_to_short.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2012 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_GR_FLOAT_TO_SHORT_H
00024 #define INCLUDED_GR_FLOAT_TO_SHORT_H
00025 
00026 #include <gr_core_api.h>
00027 #include <gr_sync_block.h>
00028 
00029 class gr_float_to_short;
00030 typedef boost::shared_ptr<gr_float_to_short> gr_float_to_short_sptr;
00031 
00032 GR_CORE_API gr_float_to_short_sptr
00033 gr_make_float_to_short (size_t vlen=1, float scale=1);
00034 
00035 /*!
00036  * \brief Convert stream of float to a stream of short
00037  *
00038  * \param vlen vector length of data streams.
00039  * \param scale a scalar multiplier to change the output signal scale.
00040  */
00041 
00042 class GR_CORE_API gr_float_to_short : public gr_sync_block
00043 {
00044   friend GR_CORE_API
00045     gr_float_to_short_sptr gr_make_float_to_short (size_t vlen, float scale);
00046   gr_float_to_short (size_t vlen, float scale);
00047 
00048   size_t d_vlen;
00049   float d_scale;
00050 
00051  public:
00052   /*!
00053    * Get the scalar multiplier value.
00054    */
00055   float scale() const;
00056 
00057   /*!
00058    * Set the scalar multiplier value.
00059    */
00060   void set_scale(float scale);
00061 
00062   virtual int work (int noutput_items,
00063                     gr_vector_const_void_star &input_items,
00064                     gr_vector_void_star &output_items);
00065 };
00066 
00067 
00068 #endif /* INCLUDED_GR_FLOAT_TO_SHORT_H */