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

.. oe:namespace:: OESz

.. meta::
   :keywords: OELigandOptResults


.. _OESz_OELigandOptResults:

.. oe:class:: OELigandOptResults

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OELigandOptResults

   This class provides a container for the results of a FF optimization of a ligand molecule.

   .. seealso::

      * :ref:`OELigandEnergy <OESz_OELigandEnergy>` class

   The :ref:`OELigandOptResults <OESz_OELigandOptResults>` class defines the following public methods:
    * :oe:meth:`GetInitialEnergies<OESz::OELigandOptResults::GetInitialEnergies>`
    * :oe:meth:`GetFinalEnergies<OESz::OELigandOptResults::GetFinalEnergies>`
    * :oe:meth:`GetRMSD<OESz::OELigandOptResults::GetRMSD>`
    * :oe:meth:`GetReturnCode<OESz::OELigandOptResults::GetReturnCode>`


   .. oe:method:: Constructor

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

         .. oe:api::

            OELigandOptResults()
            OELigandOptResults(const OELigandOptResults&)

      .. oe:language:: python

         .. oe:api:: python

            OELigandOptResults() -> OELigandOptResults
            OELigandOptResults(arg2: OELigandOptResults) -> OELigandOptResults

      Default and copy constructors.


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

      .. oe:api::

         OELigandOptResults& operator=(const OELigandOptResults&)


   .. _OESz_OELigandOptResults_GetInitialEnergies:

      Assignment operator.


   .. oe:method:: GetInitialEnergies

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

         .. oe:api::

            OELigandEnergy GetInitialEnergies() const

      .. oe:language:: python

         .. oe:api:: python

            GetInitialEnergies() -> OELigandEnergy

      Returns an object of the :ref:`OELigandEnergy <OESz_OELigandEnergy>` class
      corresponding to the FF energy at the initial (input) geometry.



   .. _OESz_OELigandOptResults_GetFinalEnergies:

   .. oe:method:: GetFinalEnergies

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

         .. oe:api::

            OELigandEnergy GetFinalEnergies() const

      .. oe:language:: python

         .. oe:api:: python

            GetFinalEnergies() -> OELigandEnergy

      Returns an object of the :ref:`OELigandEnergy <OESz_OELigandEnergy>` class
      corresponding to the FF energy at the final (optimized) geometry.



   .. _OESz_OELigandOptResults_GetRMSD:

   .. oe:method:: GetRMSD

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

         .. oe:api::

            double GetRMSD() const

      .. oe:language:: python

         .. oe:api:: python

            GetRMSD() -> float

      Returns the RMSD between the initial and final (input and optimized) geometries



   .. _OESz_OELigandOptResults_GetReturnCode:

   .. oe:method:: GetReturnCode

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

         .. oe:api::

            unsigned GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

      Returns one of the values defined in the :oe:constns:`OESz::OESzybkiReturnCode` namespace.




