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

.. oe:namespace:: OEEon

.. meta::
   :keywords: OEEonOverlayResults, EonOverlayResults


.. _OEEon_OEEonOverlayResults:

.. oe:class:: OEEonOverlayResults

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEEonOverlayResults

   This class stores all shape and charge overlay results.


   The :ref:`OEEonOverlayResults <OEEon_OEEonOverlayResults>` class defines the following public methods:
       *  :oe:meth:`GetScores<OEEon::OEEonOverlayResults::GetScores>`
       *  :oe:meth:`AddScore<OEEon::OEEonOverlayResults::AddScore>`
       *  :oe:meth:`Clear<OEEon::OEEonOverlayResults::Clear>`



   .. oe:method:: Constructors
      
      Default, constructor from :ref:`OEBestOverlayResults <OEShape_OEBestOverlayResults>` class object, and a copy constructor.

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

         .. oe:api::

            OEEonOverlayResults()
            OEEonOverlayResults(const OEShape::OEBestOverlayResults&)
            OEEonOverlayResults(const OEEon::OEEonOverlayResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEEonOverlayResults() -> OEEonOverlayResults
            OEEonOverlayResults(rhs: OEEonOverlayResults) -> OEEonOverlayResults
            OEEonOverlayResults(rhs: OEBestOverlayResults) -> OEEonOverlayResults

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

      .. oe:api::

         OEEonOverlayResults& operator=(const OEEonOverlayResults&)

      Assignment operator.


   .. oe:method:: Destructor

      .. oe:api::

         ~OEEonOverlayResults()


   .. oe:method:: GetScores

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

         .. oe:api::

            OESystem::OEIterBase<OEEonOverlayScore>* GetScores()

      .. oe:language:: python

         .. oe:api:: python

            GetScores() -> Iterable[OEEonOverlayScore]

      This method returns all the scores currently stored.

   .. oe:method:: AddScore

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

         .. oe:api::

            bool AddScore(const OEEonOverlayScore& sc)

      .. oe:language:: python

         .. oe:api:: python

            AddScore(sc: OEEonOverlayScore) -> bool

      This method adds a score to the object. 

   
   .. oe:method:: Clear

      .. oe:api::

         bool Clear()

      This method clears the contents of the object to an empty state.

