.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEDockOptions, DockOptions


.. _OEDocking_OEDockOptions:

.. oe:class:: OEDockOptions

   .. oe:api::

      class OEDockOptions : public OESystem::OEOptions

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

   The :ref:`OEDockOptions <OEDocking_OEDockOptions>` class defines the following public methods:
    * :oe:meth:`GetResolution<OEDocking::OEDockOptions::GetResolution>` and
      :oe:meth:`SetResolution<OEDocking::OEDockOptions::SetResolution>`
    * :oe:meth:`GetScoreMethod<OEDocking::OEDockOptions::GetScoreMethod>` and
      :oe:meth:`SetScoreMethod<OEDocking::OEDockOptions::SetScoreMethod>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEDockOptions()
            OEDockOptions(const OEDockOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDockOptions() -> OEDockOptions
            OEDockOptions(arg2: OEDockOptions) -> OEDockOptions

      Default and copy constructors.

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

      .. oe:api::

         OEDockOptions &operator=(const OEDockOptions &)

      Assignment operator.


   .. oe:method:: GetResolution

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

         .. oe:api::

            unsigned GetResolution() const

      .. oe:language:: python

         .. oe:api:: python

            GetResolution() -> int

      See :oe:meth:`SetResolution<OEDocking::OEDockOptions::SetResolution>` method.

   .. oe:method:: GetScoreMethod

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

         .. oe:api::

            unsigned GetScoreMethod() const

      .. oe:language:: python

         .. oe:api:: python

            GetScoreMethod() -> int

      See :oe:meth:`SetScoreMethod<OEDocking::OEDockOptions::SetScoreMethod>` method.

.. _OEDocking_OEDockOptions_SetResolution:

   .. oe:method:: SetResolution

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

         .. oe:api::

            bool SetResolution(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetResolution(value: int) -> bool

      Sets the **search resolution** for docking. Allowed resolutions are defined in the
      :oe:constns:`OEDocking::OESearchResolution` namespace.
      Default is :oe:const:`OEDocking::OESearchResolution::Standard`.

   .. oe:method:: SetScoreMethod

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

         .. oe:api::

            bool SetScoreMethod(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetScoreMethod(value: int) -> bool

      Sets the **scoring method** for docking. Allowed methods are defined in the
      :oe:constns:`OEDocking::OEDockMethod` namespace.
      Default is :oe:const:`OEDocking::OEDockMethod::Chemgauss4`.

