baz_sweep.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2004 Free Software Foundation, Inc.
 * 
 * This file is part of GNU Radio
 * 
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 * 
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

/*
 * gr-baz by Balint Seeber (http://spench.net/contact)
 * Information, documentation & samples: http://wiki.spench.net/wiki/gr-baz
 */

#ifndef INCLUDED_BAZ_SWEEP_H
#define INCLUDED_BAZ_SWEEP_H

#include <gnuradio/sync_block.h>

#include <boost/thread/mutex.hpp>
#include <boost/thread/condition_variable.hpp>

class BAZ_API baz_sweep;

/*
 * We use boost::shared_ptr's instead of raw pointers for all access
 * to gr::blocks (and many other data structures).  The shared_ptr gets
 * us transparent reference counting, which greatly simplifies storage
 * management issues.  This is especially helpful in our hybrid
 * C++ / Python system.
 *
 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
 *
 * As a convention, the _sptr suffix indicates a boost::shared_ptr
 */
typedef boost::shared_ptr<baz_sweep> baz_sweep_sptr;

/*!
 * \brief Return a shared_ptr to a new instance of baz_sweep.
 *
 * To avoid accidental use of raw pointers, baz_sweep's
 * constructor is private.  howto_make_square2_ff is the public
 * interface for creating new instances.
 */
BAZ_API baz_sweep_sptr baz_make_sweep (float samp_rate, float sweep_rate = 0.0, bool is_duration = false);

/*!
 * \brief square2 a stream of floats.
 * \ingroup block
 *
 * This uses the preferred technique: subclassing gr::sync_block.
 */
class BAZ_API baz_sweep : public gr::sync_block
{
private:
        // The friend declaration allows howto_make_square2_ff to
        // access the private constructor.

        friend BAZ_API baz_sweep_sptr baz_make_sweep (float samp_rate, float sweep_rate, bool is_duration);

        baz_sweep (float samp_rate, float sweep_rate, bool is_duration);        // private constructor

        float d_samp_rate;
        float d_default_sweep_rate;
        float d_default_is_duration;
        float d_last_output, d_target, d_sweep_rate, d_start_freq;
        boost::mutex d_mutex;
        boost::condition_variable d_sweep_done;
        uint64_t d_start_sample;

        public:
        ~baz_sweep ();  // public destructor

        void sweep(float freq, float rate = -1.0f, bool is_duration = false, bool block = false);

        //inline float exponent() const
        //{ return d_exponent; }

        int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items);
};

#endif /* INCLUDED_BAZ_SWEEP_H */