smartnet_deinterleave.h

//smartnet_deinterleave.h
/* -*- 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 2, 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.
 */
#ifndef smartnet_deinterleave_H
#define smartnet_deinterleave_H

#include <gnuradio/block.h>

class smartnet_deinterleave;

/*
 * 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<smartnet_deinterleave> smartnet_deinterleave_sptr;

/*!
 * \brief Return a shared_ptr to a new instance of smartnet_deinterleave.
 *
 * To avoid accidental use of raw pointers, smartnet_deinterleave's
 * constructor is private.  smartnet_make_deinterleave is the public
 * interface for creating new instances.
 */
smartnet_deinterleave_sptr smartnet_make_deinterleave();

/*!
 * \brief unstuff a packed stream of bits.
 * \ingroup block
 *
 *
 * This uses the preferred technique: subclassing gr_block.
 */
class smartnet_deinterleave : public gr::block
{
private:
	// The friend declaration allows smartnet_make_deinterleave to
	// access the private constructor.

	friend smartnet_deinterleave_sptr smartnet_make_deinterleave();

	smartnet_deinterleave();   // private constructor

public:
	~smartnet_deinterleave();  // public destructor

	// Where all the action really happens

	int general_work (int noutput_items,
	                  gr_vector_int &ninput_items,
	                  gr_vector_const_void_star &input_items,
	                  gr_vector_void_star &output_items);

	void forecast (int noutput_items,
	               gr_vector_int &ninput_items_required);
};

#endif /* smartnet_deinterleave_H */