.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEChem

..  _oechem_oemakesubsearchqueryscreen:

.. oe:function:: OEMakeSubSearchQueryScreen

   .. attention::

      |TWOLANGUAGE|

   .. oe:language:: c++ java csharp

      .. oe:api::

         bool OEMakeSubSearchQueryScreen(OESubSearchScreen& screen,
                                         OEQMolBase& qmol,
                                         const OESubSearchScreenTypeBase* stype)
         bool OEMakeSubSearchQueryScreen(OESubSearchScreen& screen,
                                         OEQMolBase& qmol,
                                         const unsigned stype = OESubSearchScreenType::Default)

   .. oe:language:: python

      .. oe:api:: python

         OEMakeSubSearchQueryScreen(arg1: OESubSearchScreen, arg2: OEQMol,
                                    arg3: OESubSearchScreenTypeBase) -> bool
         OEMakeSubSearchQueryScreen(arg1: OESubSearchScreen, arg2: OEQMol,
                                    stype: int) -> bool

   Generates a substructure search screen of a query molecule with the given type.

   screen
     The :ref:`OESubSearchScreen <OEChem_OESubSearchScreen>` object that is generated.

   qmol
     The query molecule of which properties are encoded into the generated screen.

   stype
     The type of the screen (either from the :oe:constns:`OEChem::OESubSearchScreenType` namespace
     or an internal screen type, :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>`).

   The :ref:`OEMakeSubSearchQueryScreen <OEChem_OEMakeSubSearchQueryScreen>` function also prepares the
   query molecule for the substructure search. For some screen types,
   the expression trees of the query are optimized for substructure search.
   The :ref:`OEMakeSubSearchQueryScreen <OEChem_OEMakeSubSearchQueryScreen>` function returns ``true``
   if the screen was successfully generated and ``false`` otherwise.

   .. note::

      For performance reason, **OEChem TK** does not support screening-based fast substructure
      search with explicit hydrogens.
      The :oe:func:`OEChem::OEMakeSubSearchQueryScreen` function will return ``false`` if the query
      molecule has any explicit hydrogen expression.

      :oe:func:`OEChem::OEIsComplementaryScreenType` function can be used to check
      whether the query molecule is suited for a specific screen type.

   .. seealso::

      * :oe:func:`OEChem::OEMakeSubSearchTargetScreen` function
      * :oe:func:`OEChem::OEScreen` function
