git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/runtime/gr_scheduler.h

   1 /* -*- c++ -*- */
   2 /*
   3  * Copyright 2008 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GNU Radio
   6  *
   7  * GNU Radio is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3, or (at your option)
  10  * any later version.
  11  *
  12  * GNU Radio is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #ifndef INCLUDED_GR_SCHEDULER_H
  23 #define INCLUDED_GR_SCHEDULER_H
  24
  25 #include <boost/utility.hpp>
  26 #include <gr_block.h>
  27 #include <gr_flat_flowgraph.h>
  28
  29
  30 class gr_scheduler;
  31 typedef boost::shared_ptr<gr_scheduler> gr_scheduler_sptr;
  32
  33
  34 /*!
  35  * \brief Abstract scheduler that takes a flattened flow graph and runs it.
  36  *
  37  * Preconditions: details, buffers and buffer readers have been assigned.
  38  */
  39 class gr_scheduler : boost::noncopyable
  40 {
  41
  42 public:
  43   /*!
  44    * \brief Construct a scheduler and begin evaluating the graph.
  45    *
  46    * The scheduler will continue running until all blocks until they
  47    * report that they are done or the stop method is called.
  48    */
  49   gr_scheduler(gr_flat_flowgraph_sptr ffg);
  50
  51   virtual ~gr_scheduler();
  52
  53   /*!
  54    * \brief Tell the scheduler to stop executing.
  55    */
  56   virtual void stop() = 0;
  57
  58   /*!
  59    * \brief Block until the graph is done.
  60    */
  61   virtual void wait() = 0;
  62 };
  63
  64 #endif /* INCLUDED_GR_SCHEDULER_H */