3 * Copyright 2006 Free Software Foundation, Inc.
5 * This file is part of GNU Radio
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)
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.
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
23 #ifndef INCLUDED_GR_BASIC_BLOCK_H
24 #define INCLUDED_GR_BASIC_BLOCK_H
26 #include <gr_runtime_types.h>
27 #include <boost/enable_shared_from_this.hpp>
31 * \brief The abstract base class for all signal processing blocks.
34 * Basic blocks are the bare abstraction of an entity that has a name
35 * and a set of inputs and outputs. These are never instantiated
36 * directly; rather, this is the abstract parent class of both gr_hier_block,
37 * which is a recursive container, and gr_block, which implements actual
38 * signal processing functions.
41 class gr_basic_block : public boost::enable_shared_from_this<gr_basic_block>
44 friend class gr_flowgraph;
45 friend class gr_flat_flowgraph; // TODO: will be redundant
47 enum vcolor { WHITE, GREY, BLACK };
50 gr_io_signature_sptr d_input_signature;
51 gr_io_signature_sptr d_output_signature;
55 //! Protected constructor prevents instantiation by non-derived classes
56 gr_basic_block(const std::string &name,
57 gr_io_signature_sptr input_signature,
58 gr_io_signature_sptr output_signature);
60 //! may only be called during constructor
61 void set_input_signature(gr_io_signature_sptr iosig) {
62 d_input_signature = iosig;
65 //! may only be called during constructor
66 void set_output_signature(gr_io_signature_sptr iosig) {
67 d_output_signature = iosig;
71 * \brief Allow the flowgraph to set for sorting and partitioning
73 void set_color(vcolor color) { d_color = color; }
74 vcolor color() const { return d_color; }
77 virtual ~gr_basic_block();
78 long unique_id() const { return d_unique_id; }
79 std::string name() const { return d_name; }
80 gr_io_signature_sptr input_signature() const { return d_input_signature; }
81 gr_io_signature_sptr output_signature() const { return d_output_signature; }
82 gr_basic_block_sptr basic_block(); // Needed for Python type coercion
85 * \brief Confirm that ninputs and noutputs is an acceptable combination.
87 * \param ninputs number of input streams connected
88 * \param noutputs number of output streams connected
90 * \returns true if this is a valid configuration for this block.
92 * This function is called by the runtime system whenever the
93 * topology changes. Most classes do not need to override this.
94 * This check is in addition to the constraints specified by the input
95 * and output gr_io_signatures.
97 virtual bool check_topology(int ninputs, int noutputs) { return true; }
100 typedef std::vector<gr_basic_block_sptr> gr_basic_block_vector_t;
101 typedef std::vector<gr_basic_block_sptr>::iterator gr_basic_block_viter_t;
103 long gr_basic_block_ncurrently_allocated();
105 inline std::ostream &operator << (std::ostream &os, gr_basic_block_sptr basic_block)
107 os << basic_block->name() << "(" << basic_block->unique_id() << ")";
111 #endif /* INCLUDED_GR_BASIC_BLOCK_H */