diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-04-17 13:43:52 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-04-29 14:52:56 -0400 |
| commit | f3e2e07201c50033bf6c9d0c6a6f068557b4f17f (patch) | |
| tree | 140b3c2d20a951ffd4abd564c3378ee2e2f9fc7c /gnuradio-runtime/lib/scheduler.h | |
| parent | 35303ae975a5b1bdecc2492bc96e2b8e89b62a3d (diff) | |
runtime: converting runtime core to gr namespace, gnuradio include dir.
Diffstat (limited to 'gnuradio-runtime/lib/scheduler.h')
| -rw-r--r-- | gnuradio-runtime/lib/scheduler.h | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/gnuradio-runtime/lib/scheduler.h b/gnuradio-runtime/lib/scheduler.h new file mode 100644 index 0000000000..575862b27d --- /dev/null +++ b/gnuradio-runtime/lib/scheduler.h @@ -0,0 +1,68 @@ +/* -*- c++ -*- */ +/* + * Copyright 2008,2013 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 <gnuradio/api.h> +#include <boost/utility.hpp> +#include <gnuradio/block.h> +#include "flat_flowgraph.h" + +namespace gr { + + class scheduler; + typedef boost::shared_ptr<scheduler> 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 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. + */ + scheduler(flat_flowgraph_sptr ffg, int max_noutput_items); + + virtual ~scheduler(); + + /*! + * \brief Tell the scheduler to stop executing. + */ + virtual void stop() = 0; + + /*! + * \brief Block until the graph is done. + */ + virtual void wait() = 0; + }; + +} /* namespace gr */ + +#endif /* INCLUDED_GR_SCHEDULER_H */ |