diff options
Diffstat (limited to 'gnuradio-runtime/include/gnuradio')
| -rw-r--r-- | gnuradio-runtime/include/gnuradio/block.h | 44 | ||||
| -rw-r--r-- | gnuradio-runtime/include/gnuradio/buffer.h | 20 |
2 files changed, 34 insertions, 30 deletions
diff --git a/gnuradio-runtime/include/gnuradio/block.h b/gnuradio-runtime/include/gnuradio/block.h index 026e4476ef..112d251587 100644 --- a/gnuradio-runtime/include/gnuradio/block.h +++ b/gnuradio-runtime/include/gnuradio/block.h @@ -86,37 +86,41 @@ namespace gr { void set_history(unsigned history); /*! - * Sets the group delay of the block. Since group delay of blocks - * like filters is derived from the taps and not the block itself, - * we cannot automatically calculate this value and so leave it as - * a user-defined property. It defaults to 0 is not set. + * Declares the block's delay in samples. Since the delay of + * blocks like filters is derived from the taps and not the block + * itself, we cannot automatically calculate this value and so + * leave it as a user-defined property. It defaults to 0 is not + * set. * - * The group delay is mostly used to adjust the placement of the - * tags and is not currently used for any signal processing. When - * a tag is passed through a block with internal delay, its - * location should be moved based on the group delay of the - * block. This interface allows us to set this. + * This does not actively set the delay; it just tells the + * scheduler what the delay is. + * + * This delay is mostly used to adjust the placement of the tags + * and is not currently used for any signal processing. When a tag + * is passed through a block with internal delay, its location + * should be moved based on the delay of the block. This interface + * allows us to tell the scheduler this value. * * \param which The buffer on which to set the delay. - * \param delay The group delay of the data stream. + * \param delay The sample delay of the data stream. */ - void set_group_delay(int which, unsigned delay); + void declare_sample_delay(int which, unsigned delay); /*! - * Convenience wrapper to gr::block::set_group_delay(int which, unsigned delay) + * Convenience wrapper to gr::block::declare_delay(int which, unsigned delay) * to set all ports to the same delay. */ - void set_group_delay(unsigned delay); + void declare_sample_delay(unsigned delay); /*! - * Gets the group delay of the block. Since group delay of blocks - * like filters is derived from the taps and not the block itself, - * we cannot automatically calculate this value and so leave it as - * a user-defined property. It defaults to 0 is not set. + * Gets the delay of the block. Since the delay of blocks like + * filters is derived from the taps and not the block itself, we + * cannot automatically calculate this value and so leave it as a + * user-defined property. It defaults to 0 is not set. * - * \param which Which port from which to get the group delay. + * \param which Which port from which to get the sample delay. */ - unsigned group_delay(int which) const; + unsigned sample_delay(int which) const; /*! * \brief Return true if this block has a fixed input to output rate. @@ -569,7 +573,7 @@ namespace gr { double d_relative_rate; // approx output_rate / input_rate block_detail_sptr d_detail; // implementation details unsigned d_history; - unsigned d_group_delay; + unsigned d_attr_delay; // the block's sample delay bool d_fixed_rate; bool d_max_noutput_items_set; // if d_max_noutput_items is valid int d_max_noutput_items; // value of max_noutput_items for this block diff --git a/gnuradio-runtime/include/gnuradio/buffer.h b/gnuradio-runtime/include/gnuradio/buffer.h index e8e142028a..4e95783733 100644 --- a/gnuradio-runtime/include/gnuradio/buffer.h +++ b/gnuradio-runtime/include/gnuradio/buffer.h @@ -140,7 +140,7 @@ namespace gr { char *d_base; // base address of buffer unsigned int d_bufsize; // in items - // Keep track of maximum group delay of any reader; Only prune tags past this. + // Keep track of maximum sample delay of any reader; Only prune tags past this. unsigned d_max_reader_delay; private: @@ -210,7 +210,7 @@ namespace gr { * \param buf is the buffer the \p gr::buffer_reader reads from. * \param nzero_preload -- number of zero items to "preload" into buffer. * \param link is the block that reads from the buffer using this gr::buffer_reader. - * \param delay Optional setting for the buffer's group delay. + * \param delay Optional setting to declare the buffer's sample delay. */ GR_RUNTIME_API buffer_reader_sptr buffer_add_reader(buffer_sptr buf, int nzero_preload, block_sptr link=block_sptr(), int delay=0); @@ -231,20 +231,20 @@ namespace gr { ~buffer_reader(); /*! - * Set group delay for this reader. + * Declares the sample delay for this reader. * - * See gr::block::set_group_delay for details. + * See gr::block::declare_sample_delay for details. * - * \param delay The new group delay + * \param delay The new sample delay */ - void set_group_delay(unsigned delay); + void declare_sample_delay(unsigned delay); /*! - * Gets the group delay for this reader. + * Gets the sample delay for this reader. * - * See gr::block::group_delay for details. + * See gr::block::sample_delay for details. */ - unsigned group_delay() const; + unsigned sample_delay() const; /*! * \brief Return number of items available for reading. @@ -318,7 +318,7 @@ namespace gr { unsigned int d_read_index; // in items [0,d->buffer.d_bufsize) uint64_t d_abs_read_offset; // num items seen since the start boost::weak_ptr<block> d_link; // block that reads via this buffer reader - unsigned d_group_delay; // group delay for tag propagation + unsigned d_attr_delay; // sample delay attribute for tag propagation //! constructor is private. Use gr::buffer::add_reader to create instances buffer_reader(buffer_sptr buffer, unsigned int read_index, |