3 * Copyright 2006,2008 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 <gr_sptr_magic.h>
28 #include <boost/enable_shared_from_this.hpp>
32 * \brief The abstract base class for all signal processing blocks.
35 * Basic blocks are the bare abstraction of an entity that has a name
36 * and a set of inputs and outputs. These are never instantiated
37 * directly; rather, this is the abstract parent class of both gr_hier_block,
38 * which is a recursive container, and gr_block, which implements actual
39 * signal processing functions.
42 class gr_basic_block : public boost::enable_shared_from_this<gr_basic_block>
45 friend class gr_flowgraph;
46 friend class gr_flat_flowgraph; // TODO: will be redundant
48 enum vcolor { WHITE, GREY, BLACK };
51 gr_io_signature_sptr d_input_signature;
52 gr_io_signature_sptr d_output_signature;
56 //! Protected constructor prevents instantiation by non-derived classes
57 gr_basic_block(const std::string &name,
58 gr_io_signature_sptr input_signature,
59 gr_io_signature_sptr output_signature);
61 //! may only be called during constructor
62 void set_input_signature(gr_io_signature_sptr iosig) {
63 d_input_signature = iosig;
66 //! may only be called during constructor
67 void set_output_signature(gr_io_signature_sptr iosig) {
68 d_output_signature = iosig;
72 * \brief Allow the flowgraph to set for sorting and partitioning
74 void set_color(vcolor color) { d_color = color; }
75 vcolor color() const { return d_color; }
78 virtual ~gr_basic_block();
79 long unique_id() const { return d_unique_id; }
80 std::string name() const { return d_name; }
81 gr_io_signature_sptr input_signature() const { return d_input_signature; }
82 gr_io_signature_sptr output_signature() const { return d_output_signature; }
83 gr_basic_block_sptr basic_block(); // Needed for Python type coercion
86 * \brief Confirm that ninputs and noutputs is an acceptable combination.
88 * \param ninputs number of input streams connected
89 * \param noutputs number of output streams connected
91 * \returns true if this is a valid configuration for this block.
93 * This function is called by the runtime system whenever the
94 * topology changes. Most classes do not need to override this.
95 * This check is in addition to the constraints specified by the input
96 * and output gr_io_signatures.
98 virtual bool check_topology(int ninputs, int noutputs) { return true; }
101 inline bool operator<(gr_basic_block_sptr lhs, gr_basic_block_sptr rhs)
103 return lhs->unique_id() < rhs->unique_id();
106 typedef std::vector<gr_basic_block_sptr> gr_basic_block_vector_t;
107 typedef std::vector<gr_basic_block_sptr>::iterator gr_basic_block_viter_t;
109 long gr_basic_block_ncurrently_allocated();
111 inline std::ostream &operator << (std::ostream &os, gr_basic_block_sptr basic_block)
113 os << basic_block->name() << "(" << basic_block->unique_id() << ")";
117 #endif /* INCLUDED_GR_BASIC_BLOCK_H */