GNU Radio 3.6.4.1 C++ API
gr_scheduler.h
Go to the documentation of this file.
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 <gr_core_api.h>
26 #include <boost/utility.hpp>
27 #include <gr_block.h>
28 #include <gr_flat_flowgraph.h>
29 
30 
31 class gr_scheduler;
33 
34 
35 /*!
36  * \brief Abstract scheduler that takes a flattened flow graph and runs it.
37  *
38  * Preconditions: details, buffers and buffer readers have been assigned.
39  */
40 class GR_CORE_API gr_scheduler : boost::noncopyable
41 {
42 
43 public:
44  /*!
45  * \brief Construct a scheduler and begin evaluating the graph.
46  *
47  * The scheduler will continue running until all blocks until they
48  * report that they are done or the stop method is called.
49  */
50  gr_scheduler(gr_flat_flowgraph_sptr ffg, int max_noutput_items);
51 
52  virtual ~gr_scheduler();
53 
54  /*!
55  * \brief Tell the scheduler to stop executing.
56  */
57  virtual void stop() = 0;
58 
59  /*!
60  * \brief Block until the graph is done.
61  */
62  virtual void wait() = 0;
63 };
64 
65 #endif /* INCLUDED_GR_SCHEDULER_H */