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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodHit, BroodHit

.. _OEBioisostere_OEBroodHit:

.. oe:class:: OEBroodHit

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodHit

   This class defines objects that contain results corresponding to a
   generated **Brood** hit from bioisosteric replacement.

   The :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` class defines the following public methods:
    * :oe:meth:`GetAbbottBioScore<OEBioisostere::OEBroodHit::GetAbbottBioScore>`
    * :oe:meth:`GetAromaticRingCount<OEBioisostere::OEBroodHit::GetAromaticRingCount>`
    * :oe:meth:`GetAttachScore<OEBioisostere::OEBroodHit::GetAttachScore>`
    * :oe:meth:`GetBeliefScore<OEBioisostere::OEBroodHit::GetBeliefScore>`
    * :oe:meth:`GetBuildRes<OEBioisostere::OEBroodHit::GetBuildRes>`
    * :oe:meth:`GetBuildStatus<OEBioisostere::OEBroodHit::GetBuildStatus>`
    * :oe:meth:`GetColorScore<OEBioisostere::OEBroodHit::GetColorScore>`
    * :oe:meth:`GetComboScore<OEBioisostere::OEBroodHit::GetComboScore>`
    * :oe:meth:`GetComplexity<OEBioisostere::OEBroodHit::GetComplexity>`
    * :oe:meth:`GetDeltaLocalStrain<OEBioisostere::OEBroodHit::GetDeltaLocalStrain>`
    * :oe:meth:`GetEgan<OEBioisostere::OEBroodHit::GetEgan>`
    * :oe:meth:`GetFragSmiles<OEBioisostere::OEBroodHit::GetFragSmiles>`
    * :oe:meth:`GetFrequency<OEBioisostere::OEBroodHit::GetFrequency>`
    * :oe:meth:`GetHeavyCount<OEBioisostere::OEBroodHit::GetHeavyCount>`
    * :oe:meth:`GetIdeaGroup<OEBioisostere::OEBroodHit::GetIdeaGroup>`
    * :oe:meth:`GetIdeaRank<OEBioisostere::OEBroodHit::GetIdeaRank>`
    * :oe:meth:`GetLipinskiAcc<OEBioisostere::OEBroodHit::GetLipinskiAcc>`
    * :oe:meth:`GetLipinskiDon<OEBioisostere::OEBroodHit::GetLipinskiDon>`
    * :oe:meth:`GetLipinskiFail<OEBioisostere::OEBroodHit::GetLipinskiFail>`
    * :oe:meth:`GetLocalStrain<OEBioisostere::OEBroodHit::GetLocalStrain>`
    * :oe:meth:`GetMol<OEBioisostere::OEBroodHit::GetMol>`
    * :oe:meth:`GetMolTanimotoCombo<OEBioisostere::OEBroodHit::GetMolTanimotoCombo>`
    * :oe:meth:`GetMolWt<OEBioisostere::OEBroodHit::GetMolWt>`
    * :oe:meth:`GetRingCount<OEBioisostere::OEBroodHit::GetRingCount>`
    * :oe:meth:`GetRingRatio<OEBioisostere::OEBroodHit::GetRingRatio>`
    * :oe:meth:`GetRotorCount<OEBioisostere::OEBroodHit::GetRotorCount>`
    * :oe:meth:`GetScores<OEBioisostere::OEBroodHit::GetScores>`
    * :oe:meth:`GetShapeScore<OEBioisostere::OEBroodHit::GetShapeScore>`
    * :oe:meth:`GetSourceMolLabel<OEBioisostere::OEBroodHit::GetSourceMolLabel>`
    * :oe:meth:`GetSourceMolSmiles<OEBioisostere::OEBroodHit::GetSourceMolSmiles>`
    * :oe:meth:`GetTPSA<OEBioisostere::OEBroodHit::GetTPSA>`
    * :oe:meth:`GetVeber<OEBioisostere::OEBroodHit::GetVeber>`
    * :oe:meth:`GetXLogP<OEBioisostere::OEBroodHit::GetXLogP>`
    * :oe:meth:`Getfsp3C<OEBioisostere::OEBroodHit::Getfsp3C>`
    * :oe:meth:`Load<OEBioisostere::OEBroodHit::Load>`
    * :oe:meth:`ToRecord<OEBioisostere::OEBroodHit::ToRecord>`

   

   .. _OEBioisostere_OEBroodHit_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodHit()
            OEBroodHit(const OEBroodHit &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodHit() -> OEBroodHit
            OEBroodHit(arg2: OEBroodHit) -> OEBroodHit

      Default and copy constructors.


   .. _OEBioisostere_OEBroodHit_operator=:
   .. oe:method:: operator=

      .. oe:language:: c++

         .. oe:api::

            OEBroodHit &operator=(const OEBroodHit &)

      Assignment operator.

   .. _OEBioisostere_OEBroodHit_GetAbbottBioScore: 

   .. oe:method:: GetAbbottBioScore

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

         .. oe:api::

            double GetAbbottBioScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetAbbottBioScore() -> float

      This method returns the Abbott bioavailability score of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetAromaticRingCount: 

   .. oe:method:: GetAromaticRingCount

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

         .. oe:api::

            unsigned GetAromaticRingCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAromaticRingCount() -> int

      This method returns the number of aromatic rings in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetAttachScore: 

   .. oe:method:: GetAttachScore

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

         .. oe:api::

            double GetAttachScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetAttachScore() -> float

      This method returns the attachment score corresponding to fragment matching.

   .. _OEBioisostere_OEBroodHit_GetBeliefScore: 

   .. oe:method:: GetBeliefScore

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

         .. oe:api::

            double GetBeliefScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetBeliefScore() -> float
            
      This method returns the belief score of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetBuildRes:

   .. oe:method:: GetBuildRes

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

         .. oe:api::

            const OEBroodBuildResult& GetBuildRes() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuildRes() -> OEBroodBuildResult

      This method returns a const reference to the :ref:`OEBroodBuildResult <OEBioisostere_OEBroodBuildResult>`
      object containing detailed build status and scoring information.

   .. _OEBioisostere_OEBroodHit_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 of the built hit. The method returns
      :oe:const:`OEBioisostere::OEBroodStatusCode::Success` if
      the build was successful, otherwise it returns an error code from the
      :oe:constns:`OEBioisostere::OEBroodStatusCode` namespace.

   .. _OEBioisostere_OEBroodHit_GetColorScore: 

   .. oe:method:: GetColorScore

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

         .. oe:api::

            double GetColorScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorScore() -> float

      This method returns the color score corresponding to fragment matching.

   .. _OEBioisostere_OEBroodHit_GetComboScore: 
   
   .. oe:method:: GetComboScore

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

         .. oe:api::

            double GetComboScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetComboScore() -> float

      This method returns the combo (shape+color) score corresponding to fragment matching.

   .. _OEBioisostere_OEBroodHit_GetComplexity: 
   
   .. oe:method:: GetComplexity

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

         .. oe:api::

            double GetComplexity() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexity() -> float

      This method returns the complexity of the generated molecule.

   .. _OEBioisostere_OEBroodHit_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 calculated delta local strain (HitStrain - QueryStrain) of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetEgan:

   .. oe:method:: GetEgan

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

         .. oe:api::

            unsigned GetEgan() const

      .. oe:language:: python

         .. oe:api:: python

            GetEgan() -> int

      This method returns the Egan bioavailability score of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetFragSmiles: 

   .. oe:method:: GetFragSmiles

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

         .. oe:api::

            std::string GetFragSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragSmiles() -> str

      This method returns the SMILES string corresponding to the replacement fragment.

   .. _OEBioisostere_OEBroodHit_GetFrequency: 
   
   .. oe:method:: GetFrequency

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

         .. oe:api::

            unsigned GetFrequency() const

      .. oe:language:: python

         .. oe:api:: python

            GetFrequency() -> int

      This method returns the frequency of the replacement fragment in the database.

   .. _OEBioisostere_OEBroodHit_GetHeavyCount: 

   .. oe:method:: GetHeavyCount

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

         .. oe:api::

            unsigned GetHeavyCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHeavyCount() -> int

      This method returns the number of heavy atoms in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetIdeaGroup: 

   .. oe:method:: GetIdeaGroup

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

         .. oe:api::

            unsigned GetIdeaGroup() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdeaGroup() -> int

      This method returns the index of the idea group the generated molecule belongs to.

   .. _OEBioisostere_OEBroodHit_GetIdeaRank: 

   .. oe:method:: GetIdeaRank

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

         .. oe:api::

            unsigned GetIdeaRank() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdeaRank() -> int

      This method returns the rank of the generated molecule within the idea group it belongs to.

   .. _OEBioisostere_OEBroodHit_GetLipinskiAcc: 

   .. oe:method:: GetLipinskiAcc

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

         .. oe:api::

            unsigned GetLipinskiAcc() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiAcc() -> int

      This method returns the number of Lipinski donors in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetLipinskiDon: 
   
   .. oe:method:: GetLipinskiDon

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

         .. oe:api::

            unsigned GetLipinskiDon() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiDon() -> int

      This method returns the number of Lipinski acceptors in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetLipinskiFail: 

   .. oe:method:: GetLipinskiFail

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

         .. oe:api::

            unsigned GetLipinskiFail() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipinskiFail() -> int

      This method returns the number of Lipinski rule-of-five failures in the generated molecule.

   .. _OEBioisostere_OEBroodHit_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 calculated local strain in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetMol: 
   
   .. oe:method:: GetMol

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

         .. oe:api::

            const OEChem::OEGraphMol& GetMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetMol() -> OEGraphMol

      This method returns the generated hit molecule.
   
   .. _OEBioisostere_OEBroodHit_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 Tanimoto combo (shape+color) score of the molecule against the query molecule.

   .. _OEBioisostere_OEBroodHit_GetMolWt: 
   
   .. oe:method:: GetMolWt

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

         .. oe:api::

            double GetMolWt() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolWt() -> float

      This method returns the molecular weight of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetRingCount: 

   .. oe:method:: GetRingCount

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

         .. oe:api::

            unsigned GetRingCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingCount() -> int

      This method returns the number of rings in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetRingRatio: 

   .. oe:method:: GetRingRatio

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

         .. oe:api::

            double GetRingRatio() const

      .. oe:language:: python

         .. oe:api:: python

            GetRingRatio() -> float

      This method returns the ratio of ring atoms to heavy atoms in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetRotorCount: 
   
   .. oe:method:: GetRotorCount

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

         .. oe:api::

            unsigned GetRotorCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotorCount() -> int

      This method returns the number of rotors in the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetScores:

   .. oe:method:: GetScores

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

         .. oe:api::

            const OEBroodScore& GetScores() const

      .. oe:language:: python

         .. oe:api:: python

            GetScores() -> OEBroodScore

      This method returns a const reference to the :ref:`OEBroodScore <OEBioisostere_OEBroodScore>`
      object containing detailed scoring information for the hit.

   .. _OEBioisostere_OEBroodHit_GetShapeScore:

   .. oe:method:: GetShapeScore

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

         .. oe:api::

            double GetShapeScore() const

      .. oe:language:: python

         .. oe:api:: python

            GetShapeScore() -> float

      This method returns the shape score corresponding to fragment matching.

   .. _OEBioisostere_OEBroodHit_GetSourceMolLabel: 

   .. oe:method:: GetSourceMolLabel

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

         .. oe:api::

            std::string GetSourceMolLabel() const

      .. oe:language:: python

         .. oe:api:: python

            GetSourceMolLabel() -> str

      This method returns the labels of the source molecules associated with the replacement fragment.

   .. _OEBioisostere_OEBroodHit_GetSourceMolSmiles: 

   .. oe:method:: GetSourceMolSmiles

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

         .. oe:api::

            std::string GetSourceMolSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            GetSourceMolSmiles() -> str

      This method returns the SMILES of the source molecules associated with the replacement fragment.

   .. _OEBioisostere_OEBroodHit_GetTPSA: 
   
   .. oe:method:: GetTPSA

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

         .. oe:api::

            double GetTPSA() const

      .. oe:language:: python

         .. oe:api:: python

            GetTPSA() -> float

      This method returns the calculated topological polar surface area of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetVeber: 
   
   .. oe:method:: GetVeber

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

         .. oe:api::

            unsigned GetVeber() const

      .. oe:language:: python

         .. oe:api:: python

            GetVeber() -> int

      This method returns the Veber bioavailability score of the generated molecule.

   .. _OEBioisostere_OEBroodHit_GetXLogP: 
   
   .. oe:method:: GetXLogP

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

         .. oe:api::

            double GetXLogP() const

      .. oe:language:: python

         .. oe:api:: python

            GetXLogP() -> float

      This method returns the calculated LogP of the generated molecule.

   .. _OEBioisostere_OEBroodHit_Getfsp3C: 
   
   .. oe:method:: Getfsp3C

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

         .. oe:api::

            double Getfsp3C() const

      .. oe:language:: python

         .. oe:api:: python

            Getfsp3C() -> float

      This method returns the fraction of sp\ :sup:`3` hybridized carbon atoms in the generated molecule.

   .. _OEBioisostere_OEBroodHit_Load: 
   .. oe:method:: Load

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

         .. oe:api::

            bool Load(const OEDataFlow::OERecord&)

      .. oe:language:: python

         .. oe:api:: python

            Load(arg2: OERecord) -> bool

      This method loads :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` from the specified
      :ref:`OERecord <OEDataFlow_OERecord>`. It returns ``true`` if successful.

   .. _OEBioisostere_OEBroodHit_ToRecord: 
   .. oe:method:: ToRecord

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

         .. oe:api::

            bool ToRecord(OEDataFlow::OERecord&) const

      .. oe:language:: python

         .. oe:api:: python

            ToRecord(arg2: OERecord) -> bool

      This method saves :ref:`OEBroodHit <OEBioisostere_OEBroodHit>` into the specified
      :ref:`OERecord <OEDataFlow_OERecord>`. It returns ``true`` if successful.
