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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodMolBuilder, BroodMolBuilder


.. _OEBioisostere_OEBroodMolBuilder:

.. oe:class:: OEBroodMolBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodMolBuilder

   This class defines the interface for building a fragment-replaced molecule
   with 3D coordinates from an :ref:`OEBroodScore<OEBioisostere_OEBroodScore>`.

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

   

   .. _OEBioisostere_OEBroodMolBuilder_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodMolBuilder(const OEBroodQuery& query,
                              const OEBroodGeneralOptions& genOpts = OEBroodGeneralOptions(),
                              const OEBroodBuildOptions& options = OEBroodBuildOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEBroodMolBuilder(query: OEBroodQuery,
                              genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
                              options: OEBroodBuildOptions = OEBroodBuildOptions()) -> OEBroodMolBuilder

      Default and copy constructor.

   .. _OEBioisostere_OEBroodMolBuilder_Build:

   .. oe:method:: Build

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

         .. oe:api::

            unsigned Build(const OEBroodScore& score, OEBroodHit& hit)
            unsigned Build(OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Build(score: OEBroodScore, hit: OEBroodHit) -> int
            Build(mol: Union[OEGraphMol,OEMol,OEQMol]) -> int

      This method builds a fragment replaced 3D Molecule.  The first overload generates
      corresponding hit data from the specified :ref:`OEBroodScore<OEBioisostere_OEBroodScore>`.
      The second overload works directly with a fragment-replaced molecule.
