Imported Upstream version 3.2.2
[debian/gnuradio] / mblock / src / lib / mb_runtime_nop.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2007 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 #ifndef INCLUDED_MB_RUNTIME_NOP_H
22 #define INCLUDED_MB_RUNTIME_NOP_H
23
24 #include <mb_runtime_base.h>
25
26 /*!
27  * \brief Public constructor (factory) for mb_runtime_nop objects.
28  */
29 mb_runtime_sptr mb_make_runtime_nop();
30
31 /*!
32  * \brief Concrete runtime that does nothing.  Used only during early QA tests.
33  */
34 class mb_runtime_nop : public mb_runtime_base
35 {
36 public:
37   mb_runtime_nop();
38   ~mb_runtime_nop();
39
40   bool run(const std::string &instance_name,
41            const std::string &class_name,
42            pmt_t user_arg,
43            pmt_t *result);
44
45 protected:
46   mb_mblock_sptr
47   create_component(const std::string &instance_name,
48                    const std::string &class_name,
49                    pmt_t user_arg);
50 };
51
52 #endif /* INCLUDED_MB_RUNTIME_NOP_H */