.. oe:namespace:: OEFF

.. meta::
   :keywords: OEComplexEnergies, ComplexEnergies


.. _OEFF_OEComplexEnergies:

.. oe:class:: OEComplexEnergies

   .. oe:api::

      class OEComplexEnergies

   This class provides energy components resulting from energy calculation for
   a protein-ligand complex.

   The :ref:`OEComplexEnergies <OEFF_OEComplexEnergies>` class defines the following public methods:
    * :oe:meth:`GetComplexSolvationEnergy<OEFF::OEComplexEnergies::GetComplexSolvationEnergy>`
    * :oe:meth:`GetDesolvationEnergy<OEFF::OEComplexEnergies::GetDesolvationEnergy>`
    * :oe:meth:`GetHostComponents<OEFF::OEComplexEnergies::GetHostComponents>`
    * :oe:meth:`GetHostEnergy<OEFF::OEComplexEnergies::GetHostEnergy>`
    * :oe:meth:`GetHostSolvationEnergy<OEFF::OEComplexEnergies::GetHostSolvationEnergy>`
    * :oe:meth:`GetInterComponents<OEFF::OEComplexEnergies::GetInterComponents>`
    * :oe:meth:`GetInterEnergy<OEFF::OEComplexEnergies::GetInterEnergy>`
    * :oe:meth:`GetLigandComponents<OEFF::OEComplexEnergies::GetLigandComponents>`
    * :oe:meth:`GetLigandEnergy<OEFF::OEComplexEnergies::GetLigandEnergy>`
    * :oe:meth:`GetLigandSolvationEnergy<OEFF::OEComplexEnergies::GetLigandSolvationEnergy>`
    * :oe:meth:`GetTotalEnergy<OEFF::OEComplexEnergies::GetTotalEnergy>`

   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEComplexEnergies()
            OEComplexEnergies(const OEComplexEnergies&)

      .. oe:language:: python

         .. oe:api:: python

            OEComplexEnergies() -> OEComplexEnergies
            OEComplexEnergies(arg2: OEComplexEnergies) -> OEComplexEnergies

      Default and copy constructors.

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

      .. oe:api::

         OEComplexEnergies &operator=(const OEComplexEnergies &)

      Assignment operator.


   .. oe:method:: GetComplexSolvationEnergy

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

         .. oe:api::

            double GetComplexSolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexSolvationEnergy() -> float

      Returns the solvation energy of the protein-ligand complex.

   .. oe:method:: GetDesolvationEnergy

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

         .. oe:api::

            double GetDesolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetDesolvationEnergy() -> float

      Returns the desolvation energy.

   .. oe:method:: GetHostComponents

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

         .. oe:api::

            OESystem::OEIterBase<OEOpt::OEFComponent>* GetHostComponents() const

      .. oe:language:: python

         .. oe:api:: python

            GetHostComponents() -> Iterable[OEFComponent]

      Returns the intra-molecular energy components of the host (protein) molecule.

   .. oe:method:: GetHostEnergy

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

         .. oe:api::

            double GetHostEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetHostEnergy() -> float

      Returns the total intra-molecular energy of the host (protein) molecule.

   .. oe:method:: GetHostSolvationEnergy

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

         .. oe:api::

            double GetHostSolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetHostSolvationEnergy() -> float

      Returns the solvation energy of the host (protein) molecule.

   .. oe:method:: GetInterComponents

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

         .. oe:api::

            OESystem::OEIterBase<OEOpt::OEFComponent>* GetInterComponents() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterComponents() -> Iterable[OEFComponent]

      Returns the inter-molecular energy components of the complex.

   .. oe:method:: GetInterEnergy

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

         .. oe:api::

            double GetInterEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetInterEnergy() -> float

      Returns the total inter-molecular energy.

   .. oe:method:: GetLigandComponents

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

         .. oe:api::

            OESystem::OEIterBase<OEOpt::OEFComponent>* GetLigandComponents() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandComponents() -> Iterable[OEFComponent]

      Returns the intra-molecular energy components of the ligand molecule.

   .. oe:method:: GetLigandEnergy

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

         .. oe:api::

            double GetLigandEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandEnergy() -> float

      Returns the total intra-molecular energy of the ligand molecule.

   .. oe:method:: GetLigandSolvationEnergy

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

         .. oe:api::

            double GetLigandSolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandSolvationEnergy() -> float

      Returns the solvation energy of the ligand molecule.

   .. 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 of the complex.
