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

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonHitlistBuilder, EonHitlistBuilder


.. _OEEon_OEEonHitlistBuilder:

.. oe:class:: OEEonHitlistBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonHitlistBuilder

   This class aggregates shape and electrostatic overlay scores into a ranked hit
   list. Use :oe:meth:`AddScore<OEEon::OEEonHitlistBuilder::AddScore>` or
   :oe:meth:`AddScores<OEEon::OEEonHitlistBuilder::AddScores>` to populate scores,
   then call :oe:meth:`Build<OEEon::OEEonHitlistBuilder::Build>` and retrieve the
   ranked results with :oe:meth:`GetHits<OEEon::OEEonHitlistBuilder::GetHits>`.


   The :ref:`OEEonHitlistBuilder <OEEon_OEEonHitlistBuilder>`  class defines the following public methods:
       * :oe:meth:`GetAddCount<OEEon::OEEonHitlistBuilder::GetAddCount>`
       * :oe:meth:`GetHitCount<OEEon::OEEonHitlistBuilder::GetHitCount>`
       * :oe:meth:`GetHits<OEEon::OEEonHitlistBuilder::GetHits>`
       * :oe:meth:`AddScore<OEEon::OEEonHitlistBuilder::AddScore>`
       * :oe:meth:`AddScores<OEEon::OEEonHitlistBuilder::AddScores>`
       * :oe:meth:`Build<OEEon::OEEonHitlistBuilder::Build>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEEonHitlistBuilder(const OEEonHitlistOptions& hitlistOptions = OEEonHitlistOptions())

      .. oe:language:: python

         .. oe:api:: python

            OEEonHitlistBuilder(hitlistOptions: OEEonHitlistOptions = OEEonHitlistOptions()) -> OEEonHitlistBuilder

      Constructor. This class is not copyable.


   .. oe:method:: Destructor

      .. oe:api::

         ~OEEonHitlistBuilder()

.. _OEEon_OEEonHitlistBuilder_GetAddCount:

   .. oe:method:: GetAddCount

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

         .. oe:api::

            unsigned GetAddCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCount() -> int

      This method returns number of added entries to the hit list.


.. _OEEon_OEEonHitlistBuilder_GetHitCount:

   .. oe:method:: GetHitCount

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

         .. oe:api::

            unsigned GetHitCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetHitCount() -> int

      This method returns the number of hits stored currently in the hit list object.

.. _OEEon_OEEonHitlistBuilder_GetHits:

   .. oe:method:: GetHits

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

         .. oe:api::

            std::vector<OEEonHit> GetHits() const
            bool GetHits(std::vector<OEEonHit>& vecHits) const

      .. oe:language:: python

         .. oe:api:: python

            GetHits() -> OEEonHitVector
            GetHits(vecHits: OEEonHitVector) -> bool

      This method returns the sorted hits.


.. _OEEon_OEEonHitlistBuilder_AddScores:

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

         .. oe:api::

            bool AddScores(const std::vector<OEEon::OEEonHit>& hits)

      .. oe:language:: python

         .. oe:api:: python

            AddScores(hits: OEEonHitVector) -> bool

      This method adds a vector of hits to the hit list object.

.. _OEEon_OEEonHitlistBuilder_AddScore:

   .. oe:method:: AddScore

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

         .. oe:api::

            bool AddScore(const OEEonOverlayScore& score,
                          const OEChem::OEMCMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            AddScore(score: OEEonOverlayScore, mol: OEMol) -> bool

      This method adds an **Eon** hit to the hit list object.

.. _OEEon_OEEonHitlistBuilder_Build:

   .. oe:method:: Build

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

         .. oe:api::

            bool Build()

      .. oe:language:: python

         .. oe:api:: python

            Build() -> bool

      This method builds internal variables to build a hit list once all scores have been added.

