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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodBuildResult, BroodBuildResult


.. _OEBioisostere_OEBroodBuildResult:

.. oe:class:: OEBroodBuildResult

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodBuildResult

   This class stores the outcome of building a candidate molecule from a scored
   replacement, build status, Tanimoto combo, local strain, and delta local strain etc, 
   used for downstream filtering and analysis. This works as a container of output
   from :ref:`OEBroodMolBuilder <OEBioisostere_OEBroodMolBuilder>`.

   The :ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>` class defines the following public methods:
    * :oe:meth:`GetBuildStatus<OEBioisostere::OEBroodBuildResult::GetBuildStatus>`
    * :oe:meth:`GetDeltaLocalStrain<OEBioisostere::OEBroodBuildResult::GetDeltaLocalStrain>`
    * :oe:meth:`GetLocalStrain<OEBioisostere::OEBroodBuildResult::GetLocalStrain>`
    * :oe:meth:`GetMolTanimotoCombo<OEBioisostere::OEBroodBuildResult::GetMolTanimotoCombo>`



   .. _OEBioisostere_OEBroodBuildResult_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodBuildResult()
            OEBroodBuildResult(const OEBroodBuildResult&)
            OEBroodBuildResult& operator=(const OEBroodBuildResult&)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodBuildResult() -> OEBroodBuildResult
            OEBroodBuildResult(arg2: OEBroodBuildResult) -> OEBroodBuildResult

      Default constructors.


   .. _OEBioisostere_OEBroodBuildResult_GetBuildStatus:

   .. oe:method:: GetBuildStatus

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

         .. oe:api::

            unsigned GetBuildStatus() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildStatus() -> int

      This method returns the status code indicating the result of the build operation.
      See the :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>` for possible values.


   .. _OEBioisostere_OEBroodBuildResult_GetDeltaLocalStrain:

   .. oe:method:: GetDeltaLocalStrain

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

         .. oe:api::

            double GetDeltaLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaLocalStrain() -> float

      This method returns the change in local strain energy relative to the query fragment.


   .. _OEBioisostere_OEBroodBuildResult_GetLocalStrain:

   .. oe:method:: GetLocalStrain

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

         .. oe:api::

            double GetLocalStrain() const

      .. oe:language:: python

         .. oe:api:: python

            GetLocalStrain() -> float

      This method returns the local strain value computed for the built molecule.


   .. _OEBioisostere_OEBroodBuildResult_GetMolTanimotoCombo:

   .. oe:method:: GetMolTanimotoCombo

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

         .. oe:api::

            double GetMolTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolTanimotoCombo() -> float

      This method returns the combined Tanimoto score (shape and color) for the built molecule.

