.. oe:namespace:: OEPB



.. meta::
   :keywords: OEBindResults, BindResults


.. _OEPB_OEBindResults:

.. oe:class:: OEBindResults

   .. oe:api::


      class OEBindResults : public OESimpleBindResults

   All energy results are in units of kT.

   The following methods are publicly inherited from :ref:`OESimpleBindResults <OEPB_OESimpleBindResults>`:

   ============================================================================================= ============================================================================================= ==============================================================================================
   :oe:meth:`operator=<OEPB::OESimpleBindResults::operator=>`                                    :oe:meth:`GetBuriedArea<OEPB::OESimpleBindResults::GetBuriedArea>`                            :oe:meth:`GetUnboundLigandZapEnergy<OEPB::OESimpleBindResults::GetUnboundLigandZapEnergy>`    
   :oe:meth:`GetBindingEnergy<OEPB::OESimpleBindResults::GetBindingEnergy>`                      :oe:meth:`GetBuriedAreaEnergy<OEPB::OESimpleBindResults::GetBuriedAreaEnergy>`                :oe:meth:`GetUnboundProteinArea<OEPB::OESimpleBindResults::GetUnboundProteinArea>`            
   :oe:meth:`GetBoundLigandArea<OEPB::OESimpleBindResults::GetBoundLigandArea>`                  :oe:meth:`GetComplexArea<OEPB::OESimpleBindResults::GetComplexArea>`                          :oe:meth:`GetUnboundProteinAreaEnergy<OEPB::OESimpleBindResults::GetUnboundProteinAreaEnergy>`
   :oe:meth:`GetBoundLigandAreaEnergy<OEPB::OESimpleBindResults::GetBoundLigandAreaEnergy>`      :oe:meth:`GetComplexAreaEnergy<OEPB::OESimpleBindResults::GetComplexAreaEnergy>`              :oe:meth:`GetUnboundProteinZapEnergy<OEPB::OESimpleBindResults::GetUnboundProteinZapEnergy>`  
   :oe:meth:`GetBoundLigandZapEnergy<OEPB::OESimpleBindResults::GetBoundLigandZapEnergy>`        :oe:meth:`GetComplexZapEnergy<OEPB::OESimpleBindResults::GetComplexZapEnergy>`                :oe:meth:`GetZapEnergy<OEPB::OESimpleBindResults::GetZapEnergy>`                              
   :oe:meth:`GetBoundProteinArea<OEPB::OESimpleBindResults::GetBoundProteinArea>`                :oe:meth:`GetConf<OEPB::OESimpleBindResults::GetConf>`                                        :oe:meth:`Print<OEPB::OESimpleBindResults::Print>`                                            
   :oe:meth:`GetBoundProteinAreaEnergy<OEPB::OESimpleBindResults::GetBoundProteinAreaEnergy>`    :oe:meth:`GetUnboundLigandArea<OEPB::OESimpleBindResults::GetUnboundLigandArea>`                                                                                                            
   :oe:meth:`GetBoundProteinZapEnergy<OEPB::OESimpleBindResults::GetBoundProteinZapEnergy>`      :oe:meth:`GetUnboundLigandAreaEnergy<OEPB::OESimpleBindResults::GetUnboundLigandAreaEnergy>`                                                                                                
   ============================================================================================= ============================================================================================= ==============================================================================================

   .. oe:method:: Constructors

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

         .. oe:api::

            OEBindResults()
            OEBindResults(const OEBindResults &)

      .. oe:language:: python

         .. oe:api:: python

            OEBindResults() -> OEBindResults
            OEBindResults(arg2: OEBindResults) -> OEBindResults

      Default and copy constructors.

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

      .. oe:api::

         OEBindResults &operator=(const OEBindResults &)


      Assignment operator.

   .. oe:method:: GetAnalyticCoulombicBindingEnergy

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

         .. oe:api::

            float GetAnalyticCoulombicBindingEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetAnalyticCoulombicBindingEnergy() -> float

      This returns the value of the analytic binding energy for the
      ligand and protein that have been set to the OEBind object.
      This is equivalent to calling
      :oe:func:`OEPB::OECalculateCoulombicBinding` where
      the same ligand and protein and inner dielectric are the
      arguments.

   .. oe:method:: GetBoundLigandCoulombEnergy

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

         .. oe:api::

            float GetBoundLigandCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundLigandCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the ligand in the
      bound state, including self-interaction.  Specially, it returns
      the ``boundLigandCoulombEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::Bind` API section.


   .. oe:method:: GetBoundProteinCoulombEnergy

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

         .. oe:api::

            float GetBoundProteinCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundProteinCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the protein in the
      bound state, including self-interaction.  Specially, it returns
      the ``boundProteinCoulombEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::Bind` API section.

   .. oe:method:: GetComplexCoulombEnergy

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

         .. oe:api::

            float GetComplexCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the complex, including
      self-interaction.  Specially, it returns the
      ``complexCoulombEnergy`` variable shown in the :oe:meth:`OEPB::OEBind::Bind`
      API section.  This is equivalent to the sum of the results
      returned by :oe:meth:`OEPB::OEBindResults::GetBoundLigandCoulombEnergy` and
      :oe:meth:`OEPB::OEBindResults::GetBoundProteinCoulombEnergy`.


   .. oe:method:: GetCoulombEnergy

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

         .. oe:api::

            float GetCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetCoulombEnergy() -> float

      Returns the difference in Coulomb energy between the complex and
      the unbound ligand and protein.  This is equivalent to
      :oe:meth:`OEPB::OEBindResults::GetComplexCoulombEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetUnboundProteinCoulombEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetUnboundLigandCoulombEnergy`.


   .. oe:method:: GetDesolvationEnergy

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

         .. oe:api::

            float GetDesolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetDesolvationEnergy() -> float

      This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetZapEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetCoulombEnergy`.

   .. oe:method:: GetLigandDesolvationEnergy

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

         .. oe:api::

            float GetLigandDesolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetLigandDesolvationEnergy() -> float

      This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetBoundLigandZapEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetBoundLigandCoulombEnergy` -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandZapEnergy` +
      :oe:meth:`OEPB::OEBindResults::GetUnboundLigandCoulombEnergy`.

   .. oe:method:: GetProteinDesolvationEnergy

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

         .. oe:api::

            float GetProteinDesolvationEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetProteinDesolvationEnergy() -> float

      This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetBoundProteinZapEnergy` -
      :oe:meth:`OEPB::OEBindResults::GetBoundProteinCoulombEnergy`
      -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundProteinZapEnergy`
      +
      :oe:meth:`OEPB::OEBindResults::GetUnboundProteinCoulombEnergy`.

   .. oe:method:: GetUnboundLigandCoulombEnergy

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

         .. oe:api::

            float GetUnboundLigandCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundLigandCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the ligand in the
      unbound state, including self-interaction.  Specially, it
      returns the ``unboundLigandCoulombEnergy`` variable shown in
      the :oe:meth:`OEPB::OEBind::Bind` API section.


   .. oe:method:: GetUnboundProteinCoulombEnergy

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

         .. oe:api::

            float GetUnboundProteinCoulombEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundProteinCoulombEnergy() -> float

      Returns the grid-based coulomb energy for the protein in the
      unbound state, including self-interaction.  Specially, it
      returns the ``unboundProteinCoulombEnergy`` variable shown in
      the :oe:meth:`OEPB::OEBind::Bind` API section.


   .. oe:method:: Print

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

         .. oe:api::

            void Print(OEPlatform::oeostream& ofs) const
            void Print(OESystem::OEErrorHandler& log) const

      .. oe:language:: python

         .. oe:api:: python

            Print(ofs: oeostream) -> None
            Print(log: OEErrorHandler) -> None

      Prints out all of the available data to the oeostream of the
      OEErrorHandle passed in.
