git.gag.com Git - debian/gnuradio/blob - grc/base/Port.py

   1 """
   2 Copyright 2008, 2009 Free Software Foundation, Inc.
   3 This file is part of GNU Radio
   4
   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.
   9
  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.
  14
  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
  18 """
  19
  20 from Element import Element
  21
  22 class Port(Element):
  23
  24         ##possible port types
  25         TYPES = []
  26
  27         def __init__(self, block, n, dir):
  28                 """
  29                 Make a new port from nested data.
  30                 @param block the parent element
  31                 @param n the nested odict
  32                 @param dir the direction source or sink
  33                 """
  34                 #build the port
  35                 Element.__init__(self, block)
  36                 #grab the data
  37                 self._name = n['name']
  38                 self._key = n['key']
  39                 self._type = n['type']
  40                 self._dir = dir
  41
  42         def validate(self):
  43                 """
  44                 Validate the port.
  45                 The port must be non-empty and type must a possible type.
  46                 """
  47                 Element.validate(self)
  48                 try: assert self.get_type() in self.TYPES
  49                 except AssertionError: self.add_error_message('Type "%s" is not a possible type.'%self.get_type())
  50
  51         def __str__(self):
  52                 if self.is_source():
  53                         return 'Source - %s(%s)'%(self.get_name(), self.get_key())
  54                 if self.is_sink():
  55                         return 'Sink - %s(%s)'%(self.get_name(), self.get_key())
  56
  57         def is_port(self): return True
  58         def get_color(self): return '#FFFFFF'
  59         def get_name(self): return self._name
  60         def get_key(self): return self._key
  61         def is_sink(self): return self._dir == 'sink'
  62         def is_source(self): return self._dir == 'source'
  63         def get_type(self): return self.get_parent().resolve_dependencies(self._type)
  64
  65         def get_connections(self):
  66                 """
  67                 Get all connections that use this port.
  68                 @return a list of connection objects
  69                 """
  70                 connections = self.get_parent().get_parent().get_connections()
  71                 connections = filter(lambda c: c.get_source() is self or c.get_sink() is self, connections)
  72                 return connections
  73
  74         def get_enabled_connections(self):
  75                 """
  76                 Get all enabled connections that use this port.
  77                 @return a list of connection objects
  78                 """
  79                 return filter(lambda c: c.get_enabled(), self.get_connections())