GNU Radio 3.5.1 C++ API
gr_scheduler.h
Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2008 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 along
00018  * with this program; if not, write to the Free Software Foundation, Inc.,
00019  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
00020  */
00021 
00022 #ifndef INCLUDED_GR_SCHEDULER_H
00023 #define INCLUDED_GR_SCHEDULER_H
00024 
00025 #include <gr_core_api.h>
00026 #include <boost/utility.hpp>
00027 #include <gr_block.h>
00028 #include <gr_flat_flowgraph.h>
00029 
00030 
00031 class gr_scheduler;
00032 typedef boost::shared_ptr<gr_scheduler> gr_scheduler_sptr;
00033 
00034 
00035 /*!
00036  * \brief Abstract scheduler that takes a flattened flow graph and runs it.
00037  *
00038  * Preconditions: details, buffers and buffer readers have been assigned.
00039  */
00040 class GR_CORE_API gr_scheduler : boost::noncopyable
00041 {
00042 
00043 public:
00044   /*!
00045    * \brief Construct a scheduler and begin evaluating the graph.
00046    *
00047    * The scheduler will continue running until all blocks until they
00048    * report that they are done or the stop method is called.
00049    */
00050   gr_scheduler(gr_flat_flowgraph_sptr ffg, int max_noutput_items);
00051 
00052   virtual ~gr_scheduler();
00053 
00054   /*!
00055    * \brief Tell the scheduler to stop executing.
00056    */
00057   virtual void stop() = 0;
00058 
00059   /*!
00060    * \brief Block until the graph is done.
00061    */
00062   virtual void wait() = 0;
00063 };
00064 
00065 #endif /* INCLUDED_GR_SCHEDULER_H */