GNU Radio 3.5.1 C++ API
gr_scheduler_sts.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 #ifndef INCLUDED_GR_SCHEDULER_STS_H
00022 #define INCLUDED_GR_SCHEDULER_STS_H
00023 
00024 #include <gr_core_api.h>
00025 #include <gr_scheduler.h>
00026 #include <gruel/thread_group.h>
00027 
00028 /*!
00029  * \brief Concrete scheduler that uses the single_threaded_scheduler
00030  */
00031 class GR_CORE_API gr_scheduler_sts : public gr_scheduler
00032 {
00033   gruel::thread_group                  d_threads;
00034 
00035 protected:
00036   /*!
00037    * \brief Construct a scheduler and begin evaluating the graph.
00038    *
00039    * The scheduler will continue running until all blocks until they
00040    * report that they are done or the stop method is called.
00041    */
00042   gr_scheduler_sts(gr_flat_flowgraph_sptr ffg, int max_noutput_items);
00043 
00044 public:
00045   static gr_scheduler_sptr make(gr_flat_flowgraph_sptr ffg, int max_noutput_items);
00046 
00047   ~gr_scheduler_sts();
00048 
00049   /*!
00050    * \brief Tell the scheduler to stop executing.
00051    */
00052   void stop();
00053 
00054   /*!
00055    * \brief Block until the graph is done.
00056    */
00057   void wait();
00058 };
00059 
00060 
00061 
00062 
00063 #endif /* INCLUDED_GR_SCHEDULER_STS_H */