src/bindings/python/bt2/bt2/query_executor.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, utils
  24 from bt2 import interrupter as bt2_interrupter
  25 from bt2 import component as bt2_component
  26 from bt2 import logging as bt2_logging
  27 from bt2 import value as bt2_value
  28 import bt2
  29
  30
  31 class QueryExecutor(object._SharedObject):
  32     _get_ref = staticmethod(native_bt.query_executor_get_ref)
  33     _put_ref = staticmethod(native_bt.query_executor_put_ref)
  34
  35     def __init__(self):
  36         ptr = native_bt.query_executor_create()
  37
  38         if ptr is None:
  39             raise bt2._MemoryError('cannot create query executor object')
  40
  41         super().__init__(ptr)
  42
  43     def add_interrupter(self, interrupter):
  44         utils._check_type(interrupter, bt2_interrupter.Interrupter)
  45         native_bt.query_executor_add_interrupter(self._ptr, interrupter._ptr)
  46
  47     def interrupt(self):
  48         native_bt.query_executor_interrupt(self._ptr)
  49
  50     @property
  51     def is_interrupted(self):
  52         is_interrupted = native_bt.query_executor_is_interrupted(self._ptr)
  53         return bool(is_interrupted)
  54
  55     def query(
  56         self,
  57         component_class,
  58         object,
  59         params=None,
  60         logging_level=bt2_logging.LoggingLevel.NONE,
  61     ):
  62         if not isinstance(component_class, bt2_component._ComponentClass):
  63             err = False
  64
  65             try:
  66                 if not issubclass(component_class, bt2_component._UserComponent):
  67                     err = True
  68             except TypeError:
  69                 err = True
  70
  71             if err:
  72                 o = component_class
  73                 raise TypeError("'{}' is not a component class object".format(o))
  74
  75         utils._check_str(object)
  76
  77         if params is None:
  78             params_ptr = native_bt.value_null
  79         else:
  80             params = bt2.create_value(params)
  81             params_ptr = params._ptr
  82
  83         utils._check_log_level(logging_level)
  84         cc_ptr = component_class._bt_component_class_ptr()
  85
  86         status, result_ptr = native_bt.query_executor_query(
  87             self._ptr, cc_ptr, object, params_ptr, logging_level
  88         )
  89         utils._handle_func_status(status, 'cannot query component class')
  90         assert result_ptr
  91         return bt2_value._create_from_ptr(result_ptr)