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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodFragPrep, BroodFragPrep


.. _OEBioisostere_OEBroodFragPrep:

.. oe:class:: OEBroodFragPrep

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodFragPrep

   This class provides facilities to prepare fragments for overlay calculations
   using :ref:`OEBroodOverlay <OEBioisostere_OEBroodOverlay>` or
   :ref:`OEFragOverlay <OEBioisostere_OEFragOverlay>`.

   The :ref:`OEBroodFragPrep <OEBioisostere_OEBroodFragPrep>` class defines the following public methods:
    * :oe:meth:`Prep<OEBioisostere::OEBroodFragPrep::Prep>`

   

   .. _OEBioisostere_OEBroodFragPrep_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodFragPrep()

      .. oe:language:: python

         .. oe:api:: python

            OEBroodFragPrep() -> OEBroodFragPrep

      Default constructor.


   .. _OEBioisostere_OEBroodFragPrep_Prep:
   .. oe:method:: Prep

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

         .. oe:api::

            bool Prep(OEChem::OEMCMolBase& fragment)

      .. oe:language:: python

         .. oe:api:: python

            Prep(fragment: OEMol) -> bool

      Prepares the specified fragment for overlay optimization.
