.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEShape

.. meta::
   :keywords: OEFlexiOverlayOptions, FlexiOverlayOptions


.. _OEShape_OEFlexiOverlayOptions:

.. oe:class:: OEFlexiOverlayOptions

   .. oe:api::

      class OEFlexiOverlayOptions : public OESystem::OEOptions

   This class provides an interface to setup options required to perform
   **flexible fitting** between the fit molecule conformers and a reference molecule 
   using :ref:`OEFlexiOverlay <OEShape_OEFlexiOverlay>`.

   .. seealso::

      * :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` class

   The :ref:`OEFlexiOverlayOptions <OEShape_OEFlexiOverlayOptions>` class defines the following public methods:
    * :oe:meth:`GetMaxOptSteps<OEShape::OEFlexiOverlayOptions::GetMaxOptSteps>` and
      :oe:meth:`SetMaxOptSteps<OEShape::OEFlexiOverlayOptions::SetMaxOptSteps>`
    * :oe:meth:`GetRigidOverlay<OEShape::OEFlexiOverlayOptions::GetRigidOverlay>` and
      :oe:meth:`SetRigidOverlay<OEShape::OEFlexiOverlayOptions::SetRigidOverlay>`
    * :oe:meth:`GetFlexiOverlapOptions<OEShape::OEFlexiOverlayOptions::GetFlexiOverlapOptions>` and
      :oe:meth:`SetFlexiOverlapOptions<OEShape::OEFlexiOverlayOptions::SetFlexiOverlapOptions>`
    * :oe:meth:`GetRigidOverlayOptions<OEShape::OEFlexiOverlayOptions::GetRigidOverlayOptions>` and
      :oe:meth:`SetRigidOverlayOptions<OEShape::OEFlexiOverlayOptions::SetRigidOverlayOptions>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEFlexiOverlayOptions()
            OEFlexiOverlayOptions(const OEFlexiOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEFlexiOverlayOptions() -> OEFlexiOverlayOptions
            OEFlexiOverlayOptions(arg2: OEFlexiOverlayOptions) -> OEFlexiOverlayOptions

      Default and copy constructors.

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

      .. oe:api::

         OEFlexiOverlayOptions &operator=(const OEFlexiOverlayOptions&)

.. _OEShape_OEFlexiOverlayOptions_GetMaxOptSteps:

      Assignment operator.



   .. oe:method:: GetMaxOptSteps

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

         .. oe:api::

            unsigned GetMaxOptSteps() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxOptSteps() -> int

      See :oe:meth:`SetMaxOptSteps<OEShape::OEFlexiOverlayOptions::SetMaxOptSteps>` method.

.. _OEShape_OEFlexiOverlayOptions_GetRigidOverlay:


   .. oe:method:: GetRigidOverlay

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

         .. oe:api::

            bool GetRigidOverlay() const

      .. oe:language:: python

         .. oe:api:: python

            GetRigidOverlay() -> bool

      See :oe:meth:`SetRigidOverlay<OEShape::OEFlexiOverlayOptions::SetRigidOverlay>` method.

.. _OEShape_OEFlexiOverlayOptions_GetFlexiOverlapOptions:


   .. oe:method:: GetFlexiOverlapOptions

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

         .. oe:api::

            OEFlexiOverlapOptions& GetFlexiOverlapOptions()
            const OEFlexiOverlapOptions& GetFlexiOverlapOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetFlexiOverlapOptions() -> OEFlexiOverlapOptions

      Returns a reference to the :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance as currently set.
      These are options related to flexible overlap optimization using shape, color, and force field.
      See also :oe:meth:`SetFlexiOverlapOptions<OEShape::OEFlexiOverlayOptions::SetFlexiOverlapOptions>` method.

.. _OEShape_OEFlexiOverlayOptions_GetRigidOverlayOptions:


   .. oe:method:: GetRigidOverlayOptions

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

         .. oe:api::

            OEOverlayOptions& GetRigidOverlayOptions()
            const OEOverlayOptions& GetRigidOverlayOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetRigidOverlayOptions() -> OEOverlayOptions

      Returns a reference to the :ref:`OEOverlayOptions <OEShape_OEOverlayOptions>` instance as currently set.
      These are options related to rigid overlay optimization using shape and color.
      See also :oe:meth:`SetRigidOverlayOptions<OEShape::OEFlexiOverlayOptions::SetRigidOverlayOptions>` method.

.. _OEShape_OEFlexiOverlayOptions_SetMaxOptSteps:


   .. oe:method:: SetMaxOptSteps

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

         .. oe:api::

            bool SetMaxOptSteps(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxOptSteps(value: int) -> bool

      Sets the maximum number of optimization iteration steps in flexible overlay optimization.
      Default: `2000` steps.

.. _OEShape_OEFlexiOverlayOptions_SetRigidOverlay:


   .. oe:method:: SetRigidOverlay

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

         .. oe:api::

            bool SetRigidOverlay(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRigidOverlay(value: bool) -> bool

      This control flag determines whether an initial rigid overlay optimization between 
      the fit molecule conformers and the reference system should be performed prior to 
      flexible optimization.
      Default: `True`.

.. _OEShape_OEFlexiOverlayOptions_SetFlexiOverlapOptions:


   .. oe:method:: SetFlexiOverlapOptions

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

         .. oe:api::

            void SetFlexiOverlapOptions(const OEFlexiOverlapOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetFlexiOverlapOptions(opts: OEFlexiOverlapOptions) -> None

      Sets the options related to flexible overlap calculations by passing in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance.

.. _OEShape_OEFlexiOverlayOptions_SetRigidOverlayOptions:


   .. oe:method:: SetRigidOverlayOptions

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

         .. oe:api::

            void SetRigidOverlayOptions(const OEOverlayOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetRigidOverlayOptions(opts: OEOverlayOptions) -> None

      Sets the options related to overlay optimization using shape and color by passing in :ref:`OEFlexiOverlapOptions <OEShape_OEFlexiOverlapOptions>` instance.
