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

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonOverlapScore, EonOverlapScore

.. _OEEon_OEEonOverlapScore:

.. oe:class:: OEEonOverlapScore

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonOverlapScore : public OEShape::OEOverlapResults

   This class stores shape and electrostatics overlap results.


The :ref:`OEEonOverlapScore <OEEon_OEEonOverlapScore>` class defines the following public methods:
    * :ref:`GetTanimoto<OEEon_OEEonOverlapScore_GetTanimoto>`
    * :ref:`GetETTanimoto<OEEon_OEEonOverlapScore_GetETTanimoto>`
    * :ref:`GetTanimotoCombo<OEEon_OEEonOverlapScore_GetTanimotoCombo>`
    * :ref:`GetETOverlap<OEEon_OEEonOverlapScore_GetETOverlap>`
    * :ref:`GetRefSelfET<OEEon_OEEonOverlapScore_GetRefSelfET>`
    * :ref:`GetFitSelfET<OEEon_OEEonOverlapScore_GetFitSelfET>`

The following methods are publicly inherited from :ref:`OEOverlapResults <OEShape_OEOverlapResults>`.

   .. oe:method:: Constructors

      Default, constructor from parent class object, and copy constructors.

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

         .. oe:api::

            OEEonOverlapScore()
            OEEonOverlapScore(const OEShape::OEOverlapResults &)
            OEEonOverlapScore(const OEEonOverlapScore &)

      .. oe:language:: python

         .. oe:api:: python

            OEEonOverlapScore() -> OEEonOverlapScore
            OEEonOverlapScore(arg2: OEOverlapResults) -> OEEonOverlapScore
            OEEonOverlapScore(arg2: OEEonOverlapScore) -> OEEonOverlapScore


   .. oe:method:: Destructor
      
      .. oe:api::

         ~OEEonOverlapScore()


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

      .. oe:api::

         OEEonOverlapScore& operator=(const OEEonOverlapScore&)

      Assignment operator.

   .. _OEEon_OEEonOverlapScore_GetTanimoto:

   .. oe:method:: GetTanimoto

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

         .. oe:api::

            float GetTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimoto() -> float

      This method returns the shape Tanimoto.

   .. _OEEon_OEEonOverlapScore_GetETTanimoto:

   .. oe:method:: GetETTanimoto

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

         .. oe:api::

            float GetETTanimoto() const

      .. oe:language:: python

         .. oe:api:: python

            GetETTanimoto() -> float

      This method returns the electrostatic Tanimoto.


   .. _OEEon_OEEonOverlapScore_GetTanimotoCombo:

   .. oe:method:: GetTanimotoCombo

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

         .. oe:api::

            float GetTanimotoCombo() const

      .. oe:language:: python

         .. oe:api:: python

            GetTanimotoCombo() -> float

      This method returns shape and electrostatics Tanimoto Combo.


   .. _OEEon_OEEonOverlapScore_GetETOverlap:

   .. oe:method:: GetETOverlap

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

         .. oe:api::

            float GetETOverlap() const

      .. oe:language:: python

         .. oe:api:: python

            GetETOverlap() -> float

      This method returns the electrostatic overlap.

   .. _OEEon_OEEonOverlapScore_GetRefSelfET:

   .. oe:method:: GetRefSelfET

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

         .. oe:api::

            float GetRefSelfET() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefSelfET() -> float

      This method returns the electrostatic reference self overlap.

   .. _OEEon_OEEonOverlapScore_GetFitSelfET:

   .. oe:method:: GetFitSelfET

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

         .. oe:api::

            float GetFitSelfET() const

      .. oe:language:: python

         .. oe:api:: python

            GetFitSelfET() -> float

      This method returns the electrostatic fit self overlap.
 