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

.. oe:namespace:: OESz

.. meta::
   :keywords: OESingleConfResult, SingleConfResult


.. _OESz_OESingleConfResult:

.. oe:class:: OESingleConfResult

   .. oe:api::


      class OESingleConfResult

   Provides per-conformer access when iterating a
   :ref:`OEFreeFormConfResults <OESz_OEFreeFormConfResults>` object.
   Each item gives properties for the conformer identified by
   :oe:meth:`OESz::OESingleConfResult::GetConfIdx`.

   The :ref:`OESingleConfResult <OESz_OESingleConfResult>` class defines the following public methods:
    * :oe:meth:`GetConfIdx<OESz::OESingleConfResult::GetConfIdx>`
    * :oe:meth:`GetDeltaE<OESz::OESingleConfResult::GetDeltaE>`
    * :oe:meth:`GetDeltaG<OESz::OESingleConfResult::GetDeltaG>`
    * :oe:meth:`GetLnQrotational<OESz::OESingleConfResult::GetLnQrotational>`
    * :oe:meth:`GetLnQvibrational<OESz::OESingleConfResult::GetLnQvibrational>`
    * :oe:meth:`GetMMFFEnergy<OESz::OESingleConfResult::GetMMFFEnergy>`
    * :oe:meth:`GetProbability<OESz::OESingleConfResult::GetProbability>`
    * :oe:meth:`GetRelativeEnergy<OESz::OESingleConfResult::GetRelativeEnergy>`
    * :oe:meth:`GetRelLnQ<OESz::OESingleConfResult::GetRelLnQ>`
    * :oe:meth:`GetRotationalEntropy<OESz::OESingleConfResult::GetRotationalEntropy>`
    * :oe:meth:`GetSolvEnergy<OESz::OESingleConfResult::GetSolvEnergy>`
    * :oe:meth:`GetTotalEnergy<OESz::OESingleConfResult::GetTotalEnergy>`
    * :oe:meth:`GetVibrationalEnergy<OESz::OESingleConfResult::GetVibrationalEnergy>`
    * :oe:meth:`GetVibrationalEntropy<OESz::OESingleConfResult::GetVibrationalEntropy>`

   The :ref:`OESingleConfResult <OESz_OESingleConfResult>` class deprecated public methods:
    * :oe:meth:`GetRMSD<OESz::OESingleConfResult::GetRMSD>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OESingleConfResult()
            OESingleConfResult(const OEChem::OEConfBase&)
            OESingleConfResult(const OESingleConfResult&)

      .. oe:language:: python

         .. oe:api:: python

            OESingleConfResult() -> OESingleConfResult
            OESingleConfResult(argConf: OEConfBase) -> OESingleConfResult
            OESingleConfResult(argRes: OESingleConfResult) -> OESingleConfResult

      Default and copy constructors.

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

      .. oe:api::

         OESingleConfResult& operator=(const OESingleConfResult&)

      Assignment operator.


   .. oe:method:: GetConfIdx

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

         .. oe:api::

            unsigned int GetConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfIdx() -> int

      Returns the conformation id for that conformation.

   .. oe:method:: GetDeltaE

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

         .. oe:api::

            double GetDeltaE() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaE() -> float

      Returns the relative intramolecular energy for that conformation, with respect to 
      the lowest intramolecular energy conformer of the whole ensemble.

   .. oe:method:: GetDeltaG

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

         .. oe:api::

            double GetDeltaG() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeltaG() -> float

      Returns the free energy of selecting that conformation from the ensemble.
       
   .. oe:method:: GetLnQrotational

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

         .. oe:api::

            double GetLnQrotational() const

      .. oe:language:: python

         .. oe:api:: python

            GetLnQrotational() -> float

      Returns the natural logarithm of the rotational partition function for that conformation.

   .. oe:method:: GetLnQvibrational

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

         .. oe:api::

            double GetLnQvibrational() const

      .. oe:language:: python

         .. oe:api:: python

            GetLnQvibrational() -> float

      Returns the natural logarithm of the vibrational partition function for that conformation.

   .. oe:method:: GetMMFFEnergy

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

         .. oe:api::

            double GetMMFFEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFEnergy() -> float

      Returns the total intermolecular energy of that conformation.

   .. oe:method:: GetProbability

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

         .. oe:api::

            double GetProbability() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbability() -> float

      Returns the probability of state associated with this conformation.

   .. oe:method:: GetRelativeEnergy

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

         .. oe:api::

            double GetRelativeEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelativeEnergy() -> float

      Returns the total relative energy (intramolecular + solvation energy ) for that conformation
      with respect to the lowest energy conformer of the whole ensemble.

   .. oe:method:: GetRelLnQ

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

         .. oe:api::

            double GetRelLnQ() const

      .. oe:language:: python

         .. oe:api:: python

            GetRelLnQ() -> float

      Returns the natural logarithm of the relative vibrational-rotational partition function
      with respect to the lowest free energy conformer: :math:`\ln q_{rel,i} = \ln q_i - \ln q_{ref}`.
      In that formula the reference conformation is the one with the lowest value returned by
      the :oe:meth:`OESz::OESingleConfResult::GetDeltaG` method. This quantity allows us to
      calculate conformer relative free energies analogously to conventional relative energies.

   .. oe:method:: GetRotationalEntropy

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

         .. oe:api::

            double GetRotationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotationalEntropy() -> float

      Returns the rotational entropy (in J/(mol K)) for that conformation.

   .. oe:method:: GetSolvEnergy

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

         .. oe:api::

            double GetSolvEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvEnergy() -> float

      Returns the solvation energy for that conformation.

   .. oe:method:: GetTotalEnergy

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

         .. oe:api::

            double GetTotalEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEnergy() -> float

      Returns the total energy (intramolecular + solvation) for that conformation.

   .. oe:method:: GetVibrationalEnergy

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

         .. oe:api::

            double GetVibrationalEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetVibrationalEnergy() -> float

      Returns the relative vibrational energy for that conformation, with respect to 
      the lowest vibrational energy conformer of the whole ensemble.

   .. oe:method:: GetVibrationalEntropy

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

         .. oe:api::

            double GetVibrationalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetVibrationalEntropy() -> float

      Returns the vibrational entropy (in J/(mol K)) for that conformation.

   .. oe:method:: GetRMSD

      .. attention::

        |DEPRECATED-API|

        .. oe:api::

            double GetRMSD() const

      Returns 0.0.  This method has been deprecated since RMSD is not a meaningful 
      quantity for a conformer in an ensemble.

