diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2012-08-21 23:38:27 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2012-08-22 21:25:23 -0400 |
| commit | 695278bc00c8203389a917190563b0a22fea800d (patch) | |
| tree | 45573477ef0c38841f3edbad8487869182089cfc /gr-digital/include/digital/ofdm_mapper_bcv.h | |
| parent | 3757197293ef59fe08caa9f391f9e77f072ea19f (diff) | |
digital: fixed up documentation and default values of digital blocks.
Diffstat (limited to 'gr-digital/include/digital/ofdm_mapper_bcv.h')
| -rw-r--r-- | gr-digital/include/digital/ofdm_mapper_bcv.h | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/gr-digital/include/digital/ofdm_mapper_bcv.h b/gr-digital/include/digital/ofdm_mapper_bcv.h index eff2d79930..d694cec835 100644 --- a/gr-digital/include/digital/ofdm_mapper_bcv.h +++ b/gr-digital/include/digital/ofdm_mapper_bcv.h @@ -33,10 +33,11 @@ namespace gr { /*! * \brief take a stream of bytes in and map to a vector of complex * constellation points suitable for IFFT input to be used in an - * ofdm modulator. Abstract class must be subclassed with - * specific mapping. + * ofdm modulator. * \ingroup modulation_blk * \ingroup ofdm_blk + * + * Abstract class must be subclassed with specific mapping. */ class DIGITAL_API ofdm_mapper_bcv : virtual public gr_sync_block { @@ -44,6 +45,14 @@ namespace gr { // gr::digital::ofdm_mapper_bcv::sptr typedef boost::shared_ptr<ofdm_mapper_bcv> sptr; + /*! + * Make an OFDM mapper block. + * + * \param sym_position vector of OFDM carrier symbols in complex space + * \param msgq_limit limit on number of messages the queue can store + * \param occupied_carriers The number of subcarriers with data in the received symbol + * \param fft_length The size of the FFT vector (occupied_carriers + unused carriers) + */ static sptr make(const std::vector<gr_complex> &constellation, unsigned msgq_limit, unsigned occupied_carriers, |