/* -*- 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.
 */
#ifndef INCLUDED_PN_CORRELATOR_CC_H
#define INCLUDED_PN_CORRELATOR_CC_H

#include <gr_block.h>
#include <gri_glfsr.h>
class pn_correlator_cc;

/*
 * 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<pn_correlator_cc> pn_correlator_cc_sptr;

/*!
 * \brief Return a shared_ptr to a new instance of pn_correlator_cc.
 *
 * To avoid accidental use of raw pointers, pn_correlator_cc's
 * constructor is private.  pn_make_correlator_cc is the public
 * interface for creating new instances.
 */
pn_correlator_cc_sptr pn_make_correlator_cc (int degree, int mask=0, int seed=1);

/*!
 * \brief square a stream of floats.
 * \ingroup block
 *
 * \sa pn_square2_ff for a version that subclasses gr_sync_block.
 */
class pn_correlator_cc : public gr_block
{
private:
  // The friend declaration allows pn_make_correlator_cc to
  // access the private constructor.

  friend pn_correlator_cc_sptr pn_make_correlator_cc (int degree, int mask, int seed);
  int        d_len;
  float      d_pn;
  gri_glfsr *d_reference;


  pn_correlator_cc ();  	// private constructor
 protected:
  pn_correlator_cc(int degree, int mask, int seed);

 public:
  void forecast (int noutput_items, gr_vector_int &ninput_items_required);
  ~pn_correlator_cc ();	// 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);
};

#endif /* INCLUDED_PN_CORRELATOR_CC_H */