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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodComboBuilder, BroodComboBuilder


.. _OEBioisostere_OEBroodComboBuilder:

.. oe:class:: OEBroodComboBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodComboBuilder

   This class enables multipoint bioisosteric exploration by combining
   overlaid fragments from different query replacements of the same molecule into a single
   composite hit. Given a primary :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` and
   its corresponding :ref:`OEBroodHit <OEBioisostere_OEBroodHit>`, a second query can be
   applied to the same molecule and the builder merges both fragment replacements into a
   combined result via its :ref:`Build <OEBioisostere_OEBroodComboBuilder_Build>` method.
   See the :ref:`combo_builder <section_examples_combo_builder>` example for a complete
   walkthrough.

   The :ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>` class defines the following public method:
    * :oe:meth:`Build<OEBioisostere::OEBroodComboBuilder::Build>`



   .. _OEBioisostere_OEBroodComboBuilder_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodComboBuilder(const OEBroodQuery& query,
                                const OEBroodHit& hit,
                                const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                                const OEBroodBuildOptions& options = OEBroodBuildOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEBroodComboBuilder(query: OEBroodQuery, hit: OEBroodHit,
                                genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                                options: OEBroodBuildOptions = OEBroodBuildOptions()) -> OEBroodComboBuilder

      This method constructs an :ref:`OEBroodComboBuilder <OEBioisostere_OEBroodComboBuilder>`
      from a secondary query and a previously built primary hit, together with
      general and build options used for the combination step.


   .. _OEBioisostere_OEBroodComboBuilder_Build:

   .. oe:method:: Build

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

         .. oe:api::

            unsigned Build(const OEBroodScore& score, OEBroodHit& hit)

      .. oe:language:: python

         .. oe:api:: python

            Build(score: OEBroodScore, hit: OEBroodHit) -> int

      This method builds a combined hit by applying the replacement encoded in ``score`` to
      the current primary hit context and writing the resulting combined hit to
      ``hit``. It returns a status code from
      :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

