gr_copy.h

Go to the documentation of this file.

/* -*- c++ -*- */
/*
 * Copyright 2006,2009 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_COPY_H
#define INCLUDED_GR_COPY_H

#include <gr_core_api.h>
#include <gr_block.h>

class gr_copy;
typedef boost::shared_ptr<gr_copy> gr_copy_sptr;

GR_CORE_API gr_copy_sptr gr_make_copy(size_t itemsize);

/*!
 * \brief output[i] = input[i]
 *
 * When enabled (default), this block copies its input to its output.
 * When disabled, this block drops its input on the floor.
 *
 */
class GR_CORE_API gr_copy : public gr_block
{
  size_t                d_itemsize;
  bool                  d_enabled;

  friend GR_CORE_API gr_copy_sptr gr_make_copy(size_t itemsize);
  gr_copy(size_t itemsize);

 public:

  bool check_topology(int ninputs, int noutputs);

  void set_enabled(bool enable) { d_enabled = enable; }
  bool enabled() const { return d_enabled;}

  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