.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormConfResults, FreeFormConfResults


.. _OESz_OEFreeFormConfResults:

.. oe:class:: OEFreeFormConfResults

   .. oe:api::


      class OEFreeFormConfResults

   Container for conformer free-energy calculation results produced by
   :ref:`OEFreeFormConf <OESz_OEFreeFormConf>` and
   :ref:`OEFreeFormConfAdvanced <OESz_OEFreeFormConfAdvanced>`.
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEFreeFormConfResults(const OEChem::OEMCMolBase&)
            OEFreeFormConfResults(const OEFreeFormConfResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormConfResults() -> OEFreeFormConfResults
            OEFreeFormConfResults(argMol: OEMol) -> OEFreeFormConfResults
            OEFreeFormConfResults(argRes: OEFreeFormConfResults) -> OEFreeFormConfResults

      Default and copy constructors.  The first variation of the constructor populates
      the object by extracting the corresponding tagged values from the molecule.  

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

      .. oe:api::

         OEFreeFormConfResults& operator=(const OEFreeFormConfResults&)

      Assignment operator.


   .. oe:method:: GetConfResult

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

         .. oe:api::

            OESingleConfResult GetConfResult(const unsigned int) const

      .. oe:language:: python

         .. oe:api:: python

            GetConfResult(argConf: int) -> OESingleConfResult

      Returns the :ref:`OESingleConfResult <OESz_OESingleConfResult>` object corresponding to
      the specified conformer index.

   .. oe:method:: GetLowestdGConfIdx

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

         .. oe:api::

            unsigned int GetLowestdGConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetLowestdGConfIdx() -> int

      Returns the conformer index corresponding to the lowest dG.

   .. oe:method:: GetLowestRelEneConfIdx

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

         .. oe:api::

            unsigned int GetLowestRelEneConfIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetLowestRelEneConfIdx() -> int

      Returns the conformer index corresponding to the lowest relative energy.

   .. oe:method:: GetNumUniqueConfs

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

         .. oe:api::

            unsigned int GetNumUniqueConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumUniqueConfs() -> int

      Returns the number of the unique conformations in the ensemble.

   .. oe:method:: PrintTxt

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

         .. oe:api::

            void PrintTxt(OEPlatform::oeostream& fileStream,
                          const std::string& molName) const

      .. oe:language:: python

         .. oe:api:: python

            PrintTxt(argStream: oeostream, argMolName: str) -> None

      Prints the results in plain text format in the provided output filestream.

   .. oe:method:: PrintCsv

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

         .. oe:api::

            void PrintCsv(OEPlatform::oeostream& fileStream,
                          const std::string& molName) const

      .. oe:language:: python

         .. oe:api:: python

            PrintCsv(argStream: oeostream, argMolName: str) -> None

      Prints the results in comma separated values (CSV) format in the provided output filestream.

   .. oe:method:: GetResultsForConformations

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

         .. oe:api::

            OESystem::OEIterBase<OESingleConfResult>* GetResultsForConformations() const

      .. oe:language:: python

         .. oe:api:: python

            GetResultsForConformations() -> Iterable[OESingleConfResult]

      Returns the iterator whose elements are :ref:`OESingleConfResult <OESz_OESingleConfResult>` objects for
      the ensemble of unique conformations. 
      
   .. oe:method:: GetTemperature

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

         .. oe:api::

            double GetTemperature() const

      .. oe:language:: python

         .. oe:api:: python

            GetTemperature() -> float

      Returns temperature for which calculations have been performed.
      
   .. oe:method:: GetTotalEntropy

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

         .. oe:api::

            double GetTotalEntropy() const

      .. oe:language:: python

         .. oe:api:: python

            GetTotalEntropy() -> float

      Returns estimated molar solution entropy for the input compound.


