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

.. oe:namespace:: OEChem

..  _OEChem_OEIsComplementaryScreenType:

.. oe:function:: OEIsComplementaryScreenType

   .. attention::

      |TWOLANGUAGE|

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

      .. oe:api::

         bool OEIsComplementaryScreenType(const OEQMolBase& qmol,
                                          const unsigned stype)
         bool OEIsComplementaryScreenType(const OEQMolBase& qmol,
                                          const OESubSearchScreenTypeBase* stype)

   .. oe:language:: python

      .. oe:api:: python

         OEIsComplementaryScreenType(arg1: OEQMol, stype: int) -> bool
         OEIsComplementaryScreenType(arg1: OEQMol,
                                     stype: OESubSearchScreenTypeBase) -> bool

   Returns whether the given query molecule can be used with a certain screen type.
   The function determines this by examining all the atom and bond expressions of the
   query molecule.
   For more explanation, see the :oe:constns:`OEChem::OESubSearchScreenType` namespace.

   qmol
     The query molecule (:ref:`OEQMolBase <OEChem_OEQMolBase>`)

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

   .. oe:language:: c++ python

      **Example**

      .. oe:source:: ComplementaryScreen.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET

      .. oe:source:: ComplementaryScreen.py
         :language: python
         :noindent:
         :frag:     SNIPPET

      The above code snippet will generate the following output.

      .. code-block:: console

         SMARTS SubSearch Screen screen type is complementary

   .. seealso::

      * :oe:constns:`OEChem::OESubSearchScreenType` namespace
      * :ref:`OESubSearchScreenTypeBase <OEChem_OESubSearchScreenTypeBase>` class
