.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEPoseOptimizerOptions, PoseOptimizerOptions


.. _OEDocking_OEPoseOptimizerOptions:

.. oe:class:: OEPoseOptimizerOptions

   .. oe:api::

      class OEPoseOptimizerOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for docking with *OEDock*.

   The :ref:`OEPoseOptimizerOptions <OEDocking_OEPoseOptimizerOptions>` class defines the following public methods:
    * :oe:meth:`GetFlexRange<OEDocking::OEPoseOptimizerOptions::GetFlexRange>` and
      :oe:meth:`SetFlexRange<OEDocking::OEPoseOptimizerOptions::SetFlexRange>`
    * :oe:meth:`GetForceField<OEDocking::OEPoseOptimizerOptions::GetForceField>` and
      :oe:meth:`SetForceField<OEDocking::OEPoseOptimizerOptions::SetForceField>`
    * :oe:meth:`GetNonBondCutoff<OEDocking::OEPoseOptimizerOptions::GetNonBondCutoff>` and
      :oe:meth:`SetNonBondCutoff<OEDocking::OEPoseOptimizerOptions::SetNonBondCutoff>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEPoseOptimizerOptions()
            OEPoseOptimizerOptions(const OEPoseOptimizerOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEPoseOptimizerOptions() -> OEPoseOptimizerOptions
            OEPoseOptimizerOptions(arg2: OEPoseOptimizerOptions) -> OEPoseOptimizerOptions

      Default and copy constructors.

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

      .. oe:api::

         OEPoseOptimizerOptions &operator=(const OEPoseOptimizerOptions &)

      Assignment operator.


   .. oe:method:: GetFlexRange

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

         .. oe:api::

            double GetFlexRange() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlexRange() -> float

      See :oe:meth:`SetFlexRange<OEDocking::OEPoseOptimizerOptions::SetFlexRange>` method.

   .. oe:method:: GetForceField

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

         .. oe:api::

            const OEFF::OEComplexFF* GetForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetForceField() -> OEComplexFF

      See :oe:meth:`SetForceField<OEDocking::OEPoseOptimizerOptions::SetForceField>` method.

   .. oe:method:: GetNonBondCutoff

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

         .. oe:api::

            double GetNonBondCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetNonBondCutoff() -> float

      See :oe:meth:`SetNonBondCutoff<OEDocking::OEPoseOptimizerOptions::SetNonBondCutoff>` method.

   .. oe:method:: SetFlexRange

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

         .. oe:api::

            bool SetFlexRange(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetFlexRange(value: float) -> bool

      Sets the **distance from ligand** defining residues that should be considered flexible during
      pose optimization. Default: 2.0

   .. oe:method:: SetForceField

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

         .. oe:api::

            bool SetForceField(const unsigned)
            bool SetForceField(const std::string&)
            bool SetForceField(const OEFF::OEComplexFF&)

      .. oe:language:: python

         .. oe:api:: python

            SetForceField(value: int) -> bool
            SetForceField(value: str) -> bool
            SetForceField(value: oeistream) -> bool
            SetForceField(value: OEComplexFF) -> bool

      Sets the **force field** for pose optimization.

   .. oe:method:: SetNonBondCutoff

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

         .. oe:api::

            bool SetNonBondCutoff(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetNonBondCutoff(value: float) -> bool

      Sets the **non-bonded interactions cutoff** during pose optimization. 
      Default: 40.0

