.. oe:namespace:: OEPB



.. meta::
   :keywords: OESimpleBindResults, SimpleBindResults


.. _OEPB_OESimpleBindResults:

.. oe:class:: OESimpleBindResults

   .. oe:api::


      class OESimpleBindResults

   This class represents  `OESimpleBindResults`.  The Zap calculations
   used for  the SimpleBindResults are  performed with the  2 separate
   dielectric  constants,  the  internal  for  the  molecule  and  the
   external for the solvent. All energy results are in units of kT.

   The following classes derive from this class:
    * :ref:`OEBindResults <OEPB_OEBindResults>`
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OESimpleBindResults()
            OESimpleBindResults(const OESimpleBindResults &)

      .. oe:language:: python

         .. oe:api:: python

            OESimpleBindResults() -> OESimpleBindResults
            OESimpleBindResults(arg2: OESimpleBindResults) -> OESimpleBindResults

      Default and copy constructors.

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

      .. oe:api::

         OESimpleBindResults &operator=(const OESimpleBindResults &)

      Assignment operator

      Assignment operator.


   .. oe:method:: GetBindingEnergy

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

         .. oe:api::

            float GetBindingEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBindingEnergy() -> float

      Returns the binding energy of the ligand and protein.
      Equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetBuriedAreaEnergy` +
      :oe:meth:`OEPB::OESimpleBindResults::GetZapEnergy`.

   .. oe:method:: GetBoundLigandArea

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

         .. oe:api::

            float GetBoundLigandArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundLigandArea() -> float

      Returns the ``boundLigandArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  The bound ligand area is the
      area of the ligand exposed to the solvent while in the bound
      state.

   .. oe:method:: GetBoundLigandAreaEnergy

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

         .. oe:api::

            float GetBoundLigandAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundLigandAreaEnergy() -> float

      Returns the ``boundLigandAreaEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy associated
      with the bound ligand area.

   .. oe:method:: GetBoundLigandZapEnergy

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

         .. oe:api::

            float GetBoundLigandZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundLigandZapEnergy() -> float

      Returns the ``boundLigandZapEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the ligand grid energy
      obtained from a Zap calculation of the complex.

   .. oe:method:: GetBoundProteinArea

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

         .. oe:api::

            float GetBoundProteinArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundProteinArea() -> float

      Returns the ``boundProteinArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the area of the protein
      exposed to the solvent while in the bound state.


   .. oe:method:: GetBoundProteinAreaEnergy

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

         .. oe:api::

            float GetBoundProteinAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundProteinAreaEnergy() -> float

      Returns the ``boundProteinAreaEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy associated
      with the bound protein area.

   .. oe:method:: GetBoundProteinZapEnergy

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

         .. oe:api::

            float GetBoundProteinZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoundProteinZapEnergy() -> float

      Returns the ``boundProteinZapEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the protein grid energy
      obtained from a Zap calculation of the complex.

   .. oe:method:: GetBuriedArea

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

         .. oe:api::

            float GetBuriedArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuriedArea() -> float

      Returns the amount of area that has become buried as a result of
      binding.  Equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundProteinArea` +
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandArea` -
      :oe:meth:`OEPB::OESimpleBindResults::GetComplexArea`.

   .. oe:method:: GetBuriedAreaEnergy

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

         .. oe:api::

            float GetBuriedAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetBuriedAreaEnergy() -> float

      Returns the energy penalty associated with the buried area of
      the complex.  Equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetComplexAreaEnergy` -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundProteinAreaEnergy`
      -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandAreaEnergy`.


   .. oe:method:: GetComplexArea

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

         .. oe:api::

            float GetComplexArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexArea() -> float

      Returns the ``complexArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the solvent accessible
      surface area of the complex.

   .. oe:method:: GetComplexAreaEnergy

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

         .. oe:api::

            float GetComplexAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexAreaEnergy() -> float

      Returns the ``complexAreaEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy of the
      solvent accessible surface area of the complex.
     
   .. oe:method:: GetComplexZapEnergy

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

         .. oe:api::

            float GetComplexZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetComplexZapEnergy() -> float

      Returns the grid energy of the complex.  This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetBoundProteinZapEnergy` +
      :oe:meth:`OEPB::OESimpleBindResults::GetBoundLigandZapEnergy`.

   .. oe:method:: GetConf

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

         .. oe:api::

            OEChem::OEConfBase* GetConf()
            const OEChem::OEConfBase* GetConf() const

      .. oe:language:: python

         .. oe:api:: python

            GetConf() -> OEConfBase

      Returns a pointer to the active conformer.

   .. oe:method:: GetUnboundLigandArea

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

         .. oe:api::

            float GetUnboundLigandArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundLigandArea() -> float

      Returns the ``unboundLigandArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the solvent accessible
      surface area of the unbound ligand.

   .. oe:method:: GetUnboundLigandAreaEnergy

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

         .. oe:api::

            float GetUnboundLigandAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundLigandAreaEnergy() -> float

      Returns the ``unboundLigandAreaEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy of the
      solvent accessible surface area of the unbound ligand.

   .. oe:method:: GetUnboundLigandZapEnergy

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

         .. oe:api::

            float GetUnboundLigandZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundLigandZapEnergy() -> float

      Returns the ``unboundLigandZapEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the grid energy of the
      unbound ligand obtained from a Zap calculation.

   .. oe:method:: GetUnboundProteinArea

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

         .. oe:api::

            float GetUnboundProteinArea() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundProteinArea() -> float

      Returns the ``unboundProteinArea`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the solvent accessible
      surface area of the unbound protein.

   .. oe:method:: GetUnboundProteinAreaEnergy

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

         .. oe:api::

            float GetUnboundProteinAreaEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundProteinAreaEnergy() -> float

      Returns the ``unboundProteinAreaEnergy`` variable shown in
      the :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the energy of the
      solvent accessible surface area of the unbound protein.

   .. oe:method:: GetUnboundProteinZapEnergy

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

         .. oe:api::

            float GetUnboundProteinZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetUnboundProteinZapEnergy() -> float

      Returns the ``unboundProteinZapEnergy`` variable shown in the
      :oe:meth:`OEPB::OEBind::SimpleBind` API section.  This is the grid energy of the
      unbound protein obtained from a Zap calculation.

   .. oe:method:: GetZapEnergy

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

         .. oe:api::

            float GetZapEnergy() const

      .. oe:language:: python

         .. oe:api:: python

            GetZapEnergy() -> float

      Returns the difference in grid energy between the complex and
      the unbound ligand and protein.  This is equivalent to
      :oe:meth:`OEPB::OESimpleBindResults::GetComplexZapEnergy` -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundProteinZapEnergy`
      -
      :oe:meth:`OEPB::OESimpleBindResults::GetUnboundLigandZapEnergy`.

   .. 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.
