.. oe:namespace:: OEDocking

.. meta::
   :keywords: OESinglePoseResult, SinglePoseResult


.. _OEDocking_OESinglePoseResult:

.. oe:class:: OESinglePoseResult

   .. oe:api::

      class OESinglePoseResult

   This class provides results of a single pose, obtained from the :ref:`OEPosit <OEDocking_OEPosit>`
   calculation.

   The :ref:`OESinglePoseResult <OEDocking_OESinglePoseResult>` class defines the following public methods:
    * :oe:meth:`GetDesignUnit<OEDocking::OESinglePoseResult::GetDesignUnit>`
    * :oe:meth:`GetTargetMask<OEDocking::OESinglePoseResult::GetTargetMask>`
    * :oe:meth:`GetTargetPred<OEDocking::OESinglePoseResult::GetTargetPred>`
    * :oe:meth:`GetHasClash<OEDocking::OESinglePoseResult::GetHasClash>`
    * :oe:meth:`GetNumClashes<OEDocking::OESinglePoseResult::GetNumClashes>`
    * :oe:meth:`GetNumContacts<OEDocking::OESinglePoseResult::GetNumContacts>`
    * :oe:meth:`GetPose<OEDocking::OESinglePoseResult::GetPose>`
    * :oe:meth:`GetPositMethod<OEDocking::OESinglePoseResult::GetPositMethod>`
    * :oe:meth:`GetProbability<OEDocking::OESinglePoseResult::GetProbability>`
    * :oe:meth:`GetReceptorIndex<OEDocking::OESinglePoseResult::GetReceptorIndex>`
    * :oe:meth:`GetRelaxAttempted<OEDocking::OESinglePoseResult::GetRelaxAttempted>`
    * :oe:meth:`GetRelaxed<OEDocking::OESinglePoseResult::GetRelaxed>`
    * :oe:meth:`GetRelaxStatus<OEDocking::OESinglePoseResult::GetRelaxStatus>`
    * :oe:meth:`GetRelaxStatusStr<OEDocking::OESinglePoseResult::GetRelaxStatusStr>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OESinglePoseResult()
            OESinglePoseResult(const OESinglePoseResult&)

      .. oe:language:: python

         .. oe:api:: python

            OESinglePoseResult() -> OESinglePoseResult
            OESinglePoseResult(arg2: OESinglePoseResult) -> OESinglePoseResult

      Default and copy constructors.

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

      .. oe:api::

         OESinglePoseResult &operator=(const OESinglePoseResult &)

      Assignment operator.


   .. oe:method:: GetDesignUnit

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

         .. oe:api::

            const OEBio::OEDesignUnit& GetDesignUnit() const

      .. oe:language:: python

         .. oe:api:: python

            GetDesignUnit() -> OEDesignUnit

      Returns the resulting design unit consisting of the target and the ligand pose.


   .. _OEDocking_OESinglePoseResult_GetTargetMask:

   .. oe:method:: GetTargetMask

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

         .. oe:api::

            unsigned GetTargetMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetMask() -> int

      Returns the target mask used to generate the receptor. The mask and predicate can be used with the
      :oe:meth:`OEBio::OEDesignUnit::GetComponents` method to generate the molecule used in receptor generation. 

   .. _OEDocking_OESinglePoseResult_GetTargetPred:

   .. oe:method:: GetTargetPred

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

         .. oe:api::

            OEBio::OEAtomMatchResidue GetTargetPred() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetPred() -> OEAtomMatchResidue

      Returns the residue based :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` predicate used with the corresponding
      target mask to generate the receptor. The mask and predicate can be used with the
      :oe:meth:`OEBio::OEDesignUnit::GetComponents` method to generate the molecule used in receptor generation. 

      .. seealso::

         * :ref:`OEAtomMatchResidue <OEBio_OEAtomMatchResidue>` class
         * :oe:meth:`OEBio::OEDesignUnit::GetComponents` method

   .. _OEDocking_OESinglePoseResult_GetHasClash:

   .. oe:method:: GetHasClash

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

         .. oe:api::

            bool GetHasClash() const

      .. oe:language:: python

         .. oe:api:: python

            GetHasClash() -> bool

      Returns ``true`` if the pose contains clash, ``false`` otherwise.  The *clash*
      is defined based on the option used in the :ref:`OEPosit <OEDocking_OEPosit>` calculation.

   .. _OEDocking_OESinglePoseResult_GetNumContacts:

   .. oe:method:: GetNumContacts

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

         .. oe:api::

            unsigned GetNumContacts() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumContacts() -> int

      Returns the *number of contacts* in the pose, based on the *clash* type
      defined during the :ref:`OEPosit <OEDocking_OEPosit>` calculation.

   .. _OEDocking_OESinglePoseResult_GetNumClashes:

   .. oe:method:: GetNumClashes

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

         .. oe:api::

            unsigned GetNumClashes() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumClashes() -> int

      Returns the *number of clashes* in the pose, based on the *clash* type
      defined during the :ref:`OEPosit <OEDocking_OEPosit>` calculation.

   .. _OEDocking_OESinglePoseResult_GetPose:

   .. oe:method:: GetPose

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

         .. oe:api::

            const OEChem::OEMolBase& GetPose() const

      .. oe:language:: python

         .. oe:api:: python

            GetPose() -> OEGraphMol

      Returns the ligand pose conformer.

   .. _OEDocking_OESinglePoseResult_GetPositMethod:

   .. oe:method:: GetPositMethod

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

         .. oe:api::

            unsigned GetPositMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetPositMethod() -> int

      Returns the method used to generate this pose. The returned values correspond
      to :oe:constns:`OEDocking::OEPositMethod`.

   .. _OEDocking_OESinglePoseResult_GetProbability:

   .. oe:method:: GetProbability

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

         .. oe:api::

            double GetProbability() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbability() -> float

      Returns the **POSIT** probability corresponding to this pose.

   .. _OEDocking_OESinglePoseResult_GetReceptorIndex:

   .. oe:method:: GetReceptorIndex

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

         .. oe:api::

            unsigned GetReceptorIndex() const

      .. oe:language:: python

         .. oe:api:: python

            GetReceptorIndex() -> int

      Returns the receptor index corresponding to the order they were added to the
      :ref:`OEPosit <OEDocking_OEPosit>` instance.

   .. _OEDocking_OESinglePoseResult_GetRelaxAttempted:

   .. oe:method:: GetRelaxAttempted

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

         .. oe:api::

            bool GetRelaxAttempted() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelaxAttempted() -> bool

      Returns ``true`` if relaxation was attempted.

   .. _OEDocking_OESinglePoseResult_GetRelaxed:

   .. oe:method:: GetRelaxed

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

         .. oe:api::

            bool GetRelaxed() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelaxed() -> bool

      Returns ``true`` if the pose is relaxed.

   .. _OEDocking_OESinglePoseResult_GetRelaxStatus:

   .. oe:method:: GetRelaxStatus

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

         .. oe:api::

            unsigned GetRelaxStatus() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelaxStatus() -> int

      Returns ``status code`` corresponding to the attempted relaxation,
      with a value from the :oe:constns:`OEDocking::OEDockingReturnCode` namespace.

   .. _OEDocking_OESinglePoseResult_GetRelaxStatusStr:

   .. oe:method:: GetRelaxStatusStr

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

         .. oe:api::

            std::string GetRelaxStatusStr() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelaxStatusStr() -> str

      Returns ``status`` corresponding to the attempted relaxation.
