.. oe:namespace:: OEDocking

.. _OEDocking_OEDockingReturnCode:

.. oe:constnamespace:: OEDockingReturnCode

   A constant from this namespace is returned by
   :oe:meth:`OEDocking::OEDock::DockMultiConformerMolecule` and :oe:meth:`OEDocking::OEPosit::Dock`
   to indicate the outcome of the docking or posing.

   .. _OEDocking_OEDockingReturnCode_Aborted:


   .. oe:constant:: Aborted

      Docking was aborted by the user (via the
      :oe:meth:`OESystem::OETracerBase::Aborted` method)

   .. _OEDocking_OEDockingReturnCode_ConformerGenError:


   .. oe:constant:: ConformerGenError

      Typically indicates the failure of :oe:meth:`OEDocking::OEPosit::Dock` to generate
      any internal conformations.

   .. _OEDocking_OEDockingReturnCode_CoordError:


   .. oe:constant:: CoordError

      The geometry of the chemical interactions on the ligand could not be
      determined.  This generally indicates that the ligand is broken
      in some way (e.g. valence errors).

   .. _OEDocking_OEDockingReturnCode_EmptyLigand:


   .. oe:constant:: EmptyLigand

      Docking failed because the ligand contained no atoms.

   .. _OEDocking_OEDockingReturnCode_EmptyProtein:


   .. oe:constant:: EmptyProtein

      The protein passed to the :oe:meth:`OEDocking::OEDock::Initialize` or :oe:meth:`OEDocking::OEPosit::Initialize`
      methods contained no atoms.

   .. _OEDocking_OEDockingReturnCode_Failure:


   .. oe:constant:: Failure

      All other docking failures.

   .. _OEDocking_OEDockingReturnCode_GridSetupError:


   .. oe:constant:: GridSetupError

      One of the scoring grids could not be setup.  This generally indicates
      that the protein structure is broken.

   .. _OEDocking_OEDockingReturnCode_InvalidScore:


   .. oe:constant:: InvalidScore

      Calculated score is near numeric limits and not valid.

   .. _OEDocking_OEDockingReturnCode_NoConstraintMatch:


   .. oe:constant:: NoConstraintMatch

      The supplied ligand cannot match the docking constraints.

   .. _OEDocking_OEDockingReturnCode_NotInitialized:


   .. oe:constant:: NotInitialized

      Docking failed because the
      :ref:`OEDock <OEDocking_OEDock>` or :ref:`OEPosit <OEDocking_OEPosit>` object has not been
      initialized (see :oe:meth:`OEDocking::OEDock::Initialize` or
      :oe:meth:`OEDocking::OEPosit::Initialize`)

   .. _OEDocking_OEDockingReturnCode_NoValidNonClashPoses:


   .. oe:constant:: NoValidNonClashPoses

      For :ref:`OEPosit <OEDocking_OEPosit>`, no poses remaining after clash removal.

   .. _OEDocking_OEDockingReturnCode_NoValidPoses:

   .. oe:constant:: NoValidPoses

      No ligand poses could fit within the active site.  Increasing the
      size of the receptor's outer contour volume
      (see :ref:`section_receptor_negative_image` section) and re-initializing the
      :ref:`OEDock <OEDocking_OEDock>` object with the new receptor may allow
      the ligand to dock.

   .. _OEDocking_OEDockingReturnCode_OptimizationError:


   .. oe:constant:: OptimizationError

      Optimization of the ligand failed.

   .. oe:constant:: OutsideGrid

      This error code is not currently used.

   .. _OEDocking_OEDockingReturnCode_ScoreError:


   .. oe:constant:: ScoreError

      Problem assigning scores with
      :oe:meth:`OEChem::OEMolBase::SetEnergy` method.

   .. _OEDocking_OEDockingReturnCode_Success:


   .. oe:constant:: Success

      Docking was successful.

   .. _OEDocking_OEDockingReturnCode_TypingError:


   .. oe:constant:: TypingError

      One or more of the atoms on the ligand could not be typed.


