diff options
| author | Johnathan Corgan <johnathan@corganlabs.com> | 2013-03-27 20:41:40 -0700 |
|---|---|---|
| committer | Johnathan Corgan <johnathan@corganlabs.com> | 2013-03-27 20:41:40 -0700 |
| commit | 2caaabf8e1dd771174fd42e51c8c8090864638e6 (patch) | |
| tree | e58fe2bc53120acfd11aa6687fe5fa0aaa58ca71 /gnuradio-runtime/lib/gr_scheduler.h | |
| parent | 40ab0030dbe821c9ed475a0b73898040f4af581c (diff) | |
| parent | d7cde125dc3661a62e1013a4a017f0f1efa46e6e (diff) | |
Merge branch 'runtime-3.7' into next
Diffstat (limited to 'gnuradio-runtime/lib/gr_scheduler.h')
| -rw-r--r-- | gnuradio-runtime/lib/gr_scheduler.h | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/gnuradio-runtime/lib/gr_scheduler.h b/gnuradio-runtime/lib/gr_scheduler.h new file mode 100644 index 0000000000..097f575c21 --- /dev/null +++ b/gnuradio-runtime/lib/gr_scheduler.h @@ -0,0 +1,65 @@ +/* -*- c++ -*- */ +/* + * Copyright 2008 Free Software Foundation, Inc. + * + * This file is part of GNU Radio + * + * GNU Radio is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3, or (at your option) + * any later version. + * + * GNU Radio is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef INCLUDED_GR_SCHEDULER_H +#define INCLUDED_GR_SCHEDULER_H + +#include <gr_runtime_api.h> +#include <boost/utility.hpp> +#include <gr_block.h> +#include <gr_flat_flowgraph.h> + + +class gr_scheduler; +typedef boost::shared_ptr<gr_scheduler> gr_scheduler_sptr; + + +/*! + * \brief Abstract scheduler that takes a flattened flow graph and runs it. + * + * Preconditions: details, buffers and buffer readers have been assigned. + */ +class GR_RUNTIME_API gr_scheduler : boost::noncopyable +{ + +public: + /*! + * \brief Construct a scheduler and begin evaluating the graph. + * + * The scheduler will continue running until all blocks until they + * report that they are done or the stop method is called. + */ + gr_scheduler(gr_flat_flowgraph_sptr ffg, int max_noutput_items); + + virtual ~gr_scheduler(); + + /*! + * \brief Tell the scheduler to stop executing. + */ + virtual void stop() = 0; + + /*! + * \brief Block until the graph is done. + */ + virtual void wait() = 0; +}; + +#endif /* INCLUDED_GR_SCHEDULER_H */ |