src/bindings/python/bt2/bt2/port.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 from bt2 import native_bt, object
  24 import bt2.component
  25 import bt2.connection
  26 import bt2.message_iterator
  27 import bt2.message
  28 import bt2
  29
  30
  31 def _create_from_ptr_and_get_ref(ptr, port_type):
  32     cls = _PORT_TYPE_TO_PYCLS.get(port_type, None)
  33
  34     if cls is None:
  35         raise TypeError('unknown port type: {}'.format(port_type))
  36
  37     return cls._create_from_ptr_and_get_ref(ptr)
  38
  39
  40 def _create_self_from_ptr_and_get_ref(ptr, port_type):
  41     cls = _PORT_TYPE_TO_USER_PYCLS.get(port_type, None)
  42
  43     if cls is None:
  44         raise TypeError('unknown port type: {}'.format(port_type))
  45
  46     return cls._create_from_ptr_and_get_ref(ptr)
  47
  48
  49 class _Port(object._SharedObject):
  50     @classmethod
  51     def _get_ref(cls, ptr):
  52         ptr = cls._as_port_ptr(ptr)
  53         return native_bt.port_get_ref(ptr)
  54
  55     @classmethod
  56     def _put_ref(cls, ptr):
  57         ptr = cls._as_port_ptr(ptr)
  58         return native_bt.port_put_ref(ptr)
  59
  60     @property
  61     def name(self):
  62         ptr = self._as_port_ptr(self._ptr)
  63         name = native_bt.port_get_name(ptr)
  64         assert name is not None
  65         return name
  66
  67     @property
  68     def connection(self):
  69         ptr = self._as_port_ptr(self._ptr)
  70         conn_ptr = native_bt.port_borrow_connection_const(ptr)
  71
  72         if conn_ptr is None:
  73             return
  74
  75         return bt2.connection._Connection._create_from_ptr_and_get_ref(conn_ptr)
  76
  77     @property
  78     def is_connected(self):
  79         return self.connection is not None
  80
  81
  82 class _InputPort(_Port):
  83     _as_port_ptr = staticmethod(native_bt.port_input_as_port_const)
  84
  85
  86 class _OutputPort(_Port):
  87     _as_port_ptr = staticmethod(native_bt.port_output_as_port_const)
  88
  89
  90 class _UserComponentPort(_Port):
  91     @classmethod
  92     def _as_port_ptr(cls, ptr):
  93         ptr = cls._as_self_port_ptr(ptr)
  94         return native_bt.self_component_port_as_port(ptr)
  95
  96     @property
  97     def connection(self):
  98         ptr = self._as_port_ptr(self._ptr)
  99         conn_ptr = native_bt.port_borrow_connection_const(ptr)
 100
 101         if conn_ptr is None:
 102             return
 103
 104         return bt2.connection._Connection._create_from_ptr_and_get_ref(conn_ptr)
 105
 106     @property
 107     def user_data(self):
 108         ptr = self._as_self_port_ptr(self._ptr)
 109         return native_bt.self_component_port_get_data(ptr)
 110
 111
 112 class _UserComponentInputPort(_UserComponentPort, _InputPort):
 113     _as_self_port_ptr = staticmethod(native_bt.self_component_port_input_as_self_component_port)
 114
 115     def create_message_iterator(self):
 116         msg_iter_ptr = native_bt.self_component_port_input_message_iterator_create(self._ptr)
 117         if msg_iter_ptr is None:
 118             raise bt2.CreationError('cannot create message iterator object')
 119
 120         return bt2.message_iterator._UserComponentInputPortMessageIterator(msg_iter_ptr)
 121
 122
 123 class _UserComponentOutputPort(_UserComponentPort, _OutputPort):
 124     _as_self_port_ptr = staticmethod(native_bt.self_component_port_output_as_self_component_port)
 125
 126
 127 _PORT_TYPE_TO_PYCLS = {
 128     native_bt.PORT_TYPE_INPUT: _InputPort,
 129     native_bt.PORT_TYPE_OUTPUT: _OutputPort,
 130 }
 131
 132
 133 _PORT_TYPE_TO_USER_PYCLS = {
 134     native_bt.PORT_TYPE_INPUT: _UserComponentInputPort,
 135     native_bt.PORT_TYPE_OUTPUT: _UserComponentOutputPort,
 136 }