.. oe:namespace:: OESz

.. meta::
   :keywords: OEFreeFormSolvResults, FreeFormSolvResults


.. _OESz_OEFreeFormSolvResults:

.. oe:class:: OEFreeFormSolvResults

   .. oe:api::


      class OEFreeFormSolvResults

   Container for solvation free-energy results returned by
   :oe:func:`OESz::OEEstimateSolvFreeEnergy`.
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEFreeFormSolvResults()
            OEFreeFormSolvResults(const OEFreeFormSolvResults&)

      .. oe:language:: python

         .. oe:api:: python

            OEFreeFormSolvResults() -> OEFreeFormSolvResults
            OEFreeFormSolvResults(ffr: OEFreeFormSolvResults) -> OEFreeFormSolvResults

      Default and copy constructors.

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

      .. oe:api::

         OEFreeFormSolvResults& operator=(const OEFreeFormSolvResults&)

      Assignment operator.


   .. oe:method:: GetAtomicPotentials

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

         .. oe:api::

            void GetAtomicPotentials(std::vector<double>& apot) const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomicPotentials(apot: OEDoubleVector) -> None

      Fills the vector passed as an arguments with calculated atomic potentials.
      Each calculated atomic potential is a sum of electrostatic and hydrophobic contributions.

   .. oe:method:: GetElectrostaticSolvationFreeEnergy

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

         .. oe:api::

            double GetElectrostaticSolvationFreeEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetElectrostaticSolvationFreeEnergy() -> float

      Returns electrostatic part of solvation free energy after calling  
      :oe:func:`OESz::OEEstimateSolvFreeEnergy` function.
      
   .. oe:method:: GetHydrophobicSolvationFreeEnergy

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

         .. oe:api::

            double GetHydrophobicSolvationFreeEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetHydrophobicSolvationFreeEnergy() -> float

      Returns hydrophobic part of solvation free energy after calling 
      :oe:func:`OESz::OEEstimateSolvFreeEnergy` function.

   .. oe:method:: GetReturnCode

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

         .. oe:api::

            unsigned int GetReturnCode() const

      .. oe:language:: python

         .. oe:api:: python

            GetReturnCode() -> int

   Returns one of the values defined in the :oe:constns:`OESz::OEFreeFormReturnCode` namespace.
   
   .. oe:method:: GetSolvationFreeEnergy

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

         .. oe:api::

            double GetSolvationFreeEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetSolvationFreeEnergy() -> float

      Returns total Gibbs free energy of hydration for the input compound after calling
      :oe:func:`OESz::OEEstimateSolvFreeEnergy` function.

   .. oe:method:: GetWarnings

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

         .. oe:api::

            void GetWarnings(std::vector<unsigned int>& warnings) const

      .. oe:language:: python

         .. oe:api:: python

            GetWarnings(warnings: OEUIntVector) -> None

   Fills the vector passed as an argument with warning codes relevant to the calculation
   performed. When no warnings are generated the returned vector is empty.
