.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPositResults, PositResults


.. _OEDocking_OEPositResults:

.. oe:class:: OEPositResults

   .. oe:api::

      class OEPositResults

   This class provides results of a collection of poses, obtained from :ref:`OEPosit <OEDocking_OEPosit>`
   calculation.

   The :ref:`OEPositResults <OEDocking_OEPositResults>` class defines the following public methods:
    * :oe:meth:`GetNumPoses<OEDocking::OEPositResults::GetNumPoses>`
    * :oe:meth:`GetReturnCode<OEDocking::OEPositResults::GetReturnCode>`
    * :oe:meth:`GetSinglePoseResults<OEDocking::OEPositResults::GetSinglePoseResults>`

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEPositResults()
            OEPositResults(const OEPositResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEPositResults() -> OEPositResults
            OEPositResults(arg2: OEPositResults) -> OEPositResults

      Default and copy constructors.

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

      .. oe:api::

         OEPositResults &operator=(const OEPositResults &)

      Assignment operator.


   .. oe:method:: GetNumPoses

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

         .. oe:api::

            unsigned GetNumPoses() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumPoses() -> int

      Returns the number of poses in this collection.

   .. oe:method:: GetReturnCode

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

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns the calculation return code, defined in 
      :oe:constns:`OEDocking::OEDockingReturnCode` namespace.

   .. oe:method:: GetSinglePoseResults

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

         .. oe:api::

            OESystem::OEIterBase<OESinglePoseResult>* GetSinglePoseResults() const

      .. oe:language:: python

         .. oe:api:: python

            GetSinglePoseResults() -> Iterable[OESinglePoseResult]

      Returns an iterator over the :ref:`OESinglePoseResult <OEDocking_OESinglePoseResult>` in this collection.
