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

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonHit, EonHit


.. _OEEon_OEEonHit:

.. oe:class:: OEEonHit

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonHit : public OEEon::OEEonOverlapScore

   This class stores results of electrostatic overlay and the hit conformer. It can be used with :ref:`OEEon::OEEonHitlistBuilder <OEEon_OEEonHitlistBuilder>` to build a hitlist of results.


The :ref:`OEEonHit <OEEon_OEEonHit>` class defines the following public methods:
    * :oe:meth:`GetMol<OEEon::OEEonHit::GetMol>`
    * :oe:meth:`GetConformerIndex<OEEon::OEEonHit::GetConformerIndex>`
    * :oe:meth:`ToRecord<OEEon::OEEonHit::ToRecord>`
    * :oe:meth:`Load<OEEon::OEEonHit::Load>`


The link to the parent method shows public methods that are inherited from :ref:`OEEon::OEEonOverlapScore <OEEon_OEEonOverlapScore>`.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEEonHit(const OEEon::OEEonOverlayScore& score,
                     const OEChem::OEMCMolBase& mol)
            OEEonHit(const OEEon::OEEonOverlapScore& score,
                     const OEChem::OEMolBase& mol)
            OEEonHit()
            OEEonHit(const OEEon::OEEonHit&)

      .. oe:language:: python

         .. oe:api:: python

            OEEonHit(score: OEEonOverlayScore, mol: OEMol) -> OEEonHit
            OEEonHit() -> OEEonHit
            OEEonHit(arg2: OEEonHit) -> OEEonHit
            OEEonHit(score: OEEonOverlapScore,
                     mol: Union[OEGraphMol,OEMol,OEQMol]) -> OEEonHit

      Constructors.

   .. oe:method:: Destructor

      .. oe:api::

         ~OEEonHit()

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEEonHit& operator=(const OEEonHit&)

      Assignment operator.


The link to the parent method shows public methods that are inherited from :ref:`OEEon::OEEonOverlapScore <OEEon_OEEonOverlapScore>`.


   .. _OEEon_OEEonHit_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 hit molecule object.


   .. _OEEon_OEEonHit_GetConformerIndex:

   .. oe:method:: GetConformerIndex

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

         .. oe:api::

            unsigned int GetConformerIndex() const

      .. oe:language:: python

         .. oe:api:: python

            GetConformerIndex() -> int

      This method returns the integer index of the best conformer from shape and electrostatics overlay computation.
  

   .. _OEEon_OEEonHit_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 converts the **Eon** hit object into a record.


   .. 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 converts a record created via :ref:`ToRecord<OEEon_OEEonHit_ToRecord>`
      method into internal variables of the :ref:`OEEon::OEEonHit <OEEon_OEEonHit>` class.


