2 Copyright 2008 Free Software Foundation, Inc.
3 This file is part of GNU Radio
5 GNU Radio Companion is free software; you can redistribute it and/or
6 modify it under the terms of the GNU General Public License
7 as published by the Free Software Foundation; either version 2
8 of the License, or (at your option) any later version.
10 GNU Radio Companion is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
19 ##@package grc.elements.Connection
20 #Flow graph connection.
21 #A connection exists between 2 ports.
22 #One port must be input, one output.
23 #The port decided whether it can have the connection.
25 from grc.elements.Element import Element
26 from grc.Utils import odict
28 class Connection(Element):
30 def __init__(self, flow_graph, porta, portb):
32 Make a new connection given the parent and 2 ports.
33 @param flow_graph the parent of this element
34 @param porta a port (any direction)
35 @param portb a port (any direction)
36 @throws Error cannot make connection
37 @return a new connection
39 Element.__init__(self, flow_graph)
41 #separate the source and sink
42 for port in (porta, portb):
43 if port.is_source(): source = port
44 if port.is_sink(): sink = port
45 #verify the source and sink
46 assert(source and sink)
47 assert(not source.is_full())
48 assert(not sink.is_full())
52 def __str__(self): return 'Connection (%s -> %s)'%(self.get_source(), self.get_sink())
54 def is_connection(self): return True
58 Validate the connections.
59 The ports must match in type.
61 source_type = self.get_source().get_type()
62 sink_type = self.get_sink().get_type()
63 try: assert source_type == sink_type
64 except AssertionError: self._add_error_message('Source type "%s" does not match sink type "%s".'%(source_type, sink_type))
66 def get_enabled(self):
68 Get the enabled state of this connection.
69 @return true if source and sink blocks are enabled
71 return self.get_source().get_parent().get_enabled() and \
72 self.get_sink().get_parent().get_enabled()
74 #############################
76 #############################
77 def get_sink(self): return self._sink
78 def get_source(self): return self._source
80 ##############################################
81 ## Import/Export Methods
82 ##############################################
83 def export_data(self):
85 Export this connection's info.
86 @return a nested data odict
89 n['source_block_id'] = self.get_source().get_parent().get_id()
90 n['sink_block_id'] = self.get_sink().get_parent().get_id()
91 n['source_key'] = self.get_source().get_key()
92 n['sink_key'] = self.get_sink().get_key()