gr_copy Class Reference
[Miscellaneous Blocks]

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. More...

#include <gr_copy.h>

Inheritance diagram for gr_copy:
Inheritance graph
[legend]

List of all members.

Public Member Functions

bool check_topology (int ninputs, int noutputs)
 Confirm that ninputs and noutputs is an acceptable combination.
void set_enabled (bool enable)
bool enabled () const
int general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 compute output items from input items

Friends

gr_copy_sptr gr_make_copy (size_t itemsize)

Detailed Description

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.


Member Function Documentation

bool gr_copy::check_topology ( int  ninputs,
int  noutputs 
) [virtual]

Confirm that ninputs and noutputs is an acceptable combination.

Parameters:
ninputs number of input streams connected
noutputs number of output streams connected
Returns:
true if this is a valid configuration for this block.

This function is called by the runtime system whenever the topology changes. Most classes do not need to override this. This check is in addition to the constraints specified by the input and output gr_io_signatures.

Reimplemented from gr_basic_block.

bool gr_copy::enabled (  )  const [inline]
int gr_copy::general_work ( int  noutput_items,
gr_vector_int ninput_items,
gr_vector_const_void_star input_items,
gr_vector_void_star output_items 
) [virtual]

compute output items from input items

Parameters:
noutput_items number of output items to write on each output stream
ninput_items number of input items available on each input stream
input_items vector of pointers to the input items, one entry per input stream
output_items vector of pointers to the output items, one entry per output stream
Returns:
number of items actually written to each output stream, or -1 on EOF. It is OK to return a value less than noutput_items. -1 <= return value <= noutput_items

general_work must call consume or consume_each to indicate how many items were consumed on each input stream.

Implements gr_block.

void gr_copy::set_enabled ( bool  enable  )  [inline]

Friends And Related Function Documentation

gr_copy_sptr gr_make_copy ( size_t  itemsize  )  [friend]

The documentation for this class was generated from the following file:
Generated on Sat Oct 23 17:28:40 2010 for GNU Radio 3.3.0 C++ API by  doxygen 1.6.3