GNU Radio 3.5.1 C++ API
trellis_constellation_metrics_cf.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2004,2010,2011 Free Software Foundation, Inc.
00004  * 
00005  * This file is part of GNU Radio
00006  * 
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  * 
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  * 
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_TRELLIS_CONSTELLATION_METRICS_CF_H
00024 #define INCLUDED_TRELLIS_CONSTELLATION_METRICS_CF_H
00025 
00026 #include <trellis_api.h>
00027 #include <gr_block.h>
00028 #include <digital_constellation.h>
00029 #include <digital_metric_type.h>
00030 
00031 class trellis_constellation_metrics_cf;
00032 typedef boost::shared_ptr<trellis_constellation_metrics_cf> trellis_constellation_metrics_cf_sptr;
00033 
00034 TRELLIS_API trellis_constellation_metrics_cf_sptr trellis_make_constellation_metrics_cf (digital_constellation_sptr constellation, trellis_metric_type_t TYPE);
00035 
00036 /*!
00037  * \brief Evaluate metrics for use by the Viterbi algorithm.
00038  * \ingroup coding_blk
00039  */
00040 class TRELLIS_API trellis_constellation_metrics_cf : public gr_block
00041 {
00042  public:
00043   void forecast (int noutput_items,
00044                  gr_vector_int &ninput_items_required);
00045   int general_work (int noutput_items,
00046                     gr_vector_int &ninput_items,
00047                     gr_vector_const_void_star &input_items,
00048                     gr_vector_void_star &output_items);
00049  protected:
00050   trellis_constellation_metrics_cf (digital_constellation_sptr constellation, trellis_metric_type_t TYPE);
00051  
00052  private:
00053   digital_constellation_sptr d_constellation;
00054   trellis_metric_type_t d_TYPE;
00055   unsigned int d_O;
00056   unsigned int d_D;
00057   friend TRELLIS_API trellis_constellation_metrics_cf_sptr trellis_make_constellation_metrics_cf (digital_constellation_sptr constellation, trellis_metric_type_t TYPE);
00058 
00059 };
00060 
00061 
00062 #endif