check_lfsr_32k_s.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2004,2013 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_GR_CHECK_LFSR_32K_S_H
#define INCLUDED_GR_CHECK_LFSR_32K_S_H

#include <blocks/api.h>
#include <gr_sync_block.h>

namespace gr {
  namespace blocks {

    /*!
     * \brief sink that checks if its input stream consists of a lfsr_32k sequence.
     * \ingroup sink_blk
     *
     * \details
     * This sink is typically used along with
     * gr::blocks::lfsr_32k_source_s to test the USRP using its
     * digital loopback mode.
     */
    class BLOCKS_API check_lfsr_32k_s : virtual public gr_sync_block
    {
    public:
      // gr::blocks::check_lfsr_32k_s::sptr
      typedef boost::shared_ptr<check_lfsr_32k_s> sptr;

      static sptr make();

      virtual long ntotal () const = 0;
      virtual long nright () const = 0;
      virtual long runlength () const = 0;
    };

  } /* namespace blocks */
} /* namespace gr */

#endif /* INCLUDED_GR_CHECK_LFSR_32K_S_H */