.. oe:namespace:: OESz

.. meta::
   :keywords: OEProteinLigandOptResults, ProteinLigandOptResults


.. _OESz_OEProteinLigandOptResults:

.. oe:class:: OEProteinLigandOptResults

   .. oe:api::

      class OEProteinLigandOptResults

   This class provides results of optimization of a single conformer of a molecule, obtained 
   from :ref:`OEFixedProteinLigandOptimizer <OESz_OEFixedProteinLigandOptimizer>` and :ref:`OEFlexProteinLigandOptimizer <OESz_OEFlexProteinLigandOptimizer>` calculations.

   The :ref:`OEProteinLigandOptResults <OESz_OEProteinLigandOptResults>` class defines the following public methods:
    * :oe:meth:`GetReturnCode<OESz::OEProteinLigandOptResults::GetReturnCode>`
    * :oe:meth:`GetInitialEnergies<OESz::OEProteinLigandOptResults::GetInitialEnergies>`
    * :oe:meth:`GetFinalEnergies<OESz::OEProteinLigandOptResults::GetFinalEnergies>`
    * :oe:meth:`GetLigandRMSD<OESz::OEProteinLigandOptResults::GetLigandRMSD>`
    * :oe:meth:`GetProteinRMSD<OESz::OEProteinLigandOptResults::GetProteinRMSD>`
    * :oe:meth:`GetTotalRMSD<OESz::OEProteinLigandOptResults::GetTotalRMSD>`

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEProteinLigandOptResults()
            OEProteinLigandOptResults(const OEProteinLigandOptResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEProteinLigandOptResults() -> OEProteinLigandOptResults
            OEProteinLigandOptResults(arg2: OEProteinLigandOptResults) -> OEProteinLigandOptResults

      Default and copy constructors.

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

      .. oe:api::

         OEProteinLigandOptResults &operator=(const OEProteinLigandOptResults &)

      Assignment operator.


   .. 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:`OESz::OESzybkiReturnCode` namespace.

   .. oe:method:: GetInitialEnergies

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

         .. oe:api::

            const OEFF::OEComplexEnergies& GetInitialEnergies() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialEnergies() -> OEComplexEnergies

      Returns initial energies of the protein-ligand system, before optimization.

   .. oe:method:: GetFinalEnergies

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

         .. oe:api::

            const OEFF::OEComplexEnergies& GetFinalEnergies() const

      .. oe:language:: python

         .. oe:api:: python

            GetFinalEnergies() -> OEComplexEnergies

      Returns final energies of the protein-ligand system, after optimization.

   .. oe:method:: GetLigandRMSD

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

         .. oe:api::

            double GetLigandRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandRMSD() -> float

      Returns the RMSD between the initial and final conformations of the ligand.

   .. oe:method:: GetProteinRMSD

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

         .. oe:api::

            double GetProteinRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinRMSD() -> float

      Returns the RMSD between the initial and final conformations of the protein.

   .. oe:method:: GetTotalRMSD

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

         .. oe:api::

            double GetTotalRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalRMSD() -> float

      Returns the RMSD between the initial and final conformations of the protein-ligand complex.
