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

.. oe:namespace:: OEShape

.. meta::
   :keywords: OEOverlapPrepOptions, OverlapPrepOptions


.. _OEShape_OEOverlapPrepOptions:

.. oe:class:: OEOverlapPrepOptions

   .. oe:api::

      class OEOverlapPrepOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for
   :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`. 
   In addition to preparing options available in :ref:`OEOverlapPrep <OEShape_OEOverlapPrep>`,
   this option class provides two more additional options to control the :ref:`Prep <OEShape_OEOverlapPrep_Prep>`
   process regarding the removal of color atoms which are closer than a threshold distance.

   The :ref:`OEOverlapPrepOptions <OEShape_OEOverlapPrepOptions>` class defines the following public methods:

   * :oe:meth:`GetAssignBondiRadii<OEShape::OEOverlapPrepOptions::GetAssignBondiRadii>` and
     :oe:meth:`SetAssignBondiRadii<OEShape::OEOverlapPrepOptions::SetAssignBondiRadii>`
   * :oe:meth:`GetAssignColor<OEShape::OEOverlapPrepOptions::GetAssignColor>` and
     :oe:meth:`SetAssignColor<OEShape::OEOverlapPrepOptions::SetAssignColor>`
   * :oe:meth:`GetDuplicateDistance<OEShape::OEOverlapPrepOptions::GetDuplicateDistance>` and
     :oe:meth:`SetDuplicateDistance<OEShape::OEOverlapPrepOptions::SetDuplicateDistance>`
   * :oe:meth:`AddDuplicateSmarts<OEShape::OEOverlapPrepOptions::AddDuplicateSmarts>`,
     :oe:meth:`GetDuplicateSmarts<OEShape::OEOverlapPrepOptions::GetDuplicateSmarts>`, and
     :oe:meth:`ClearDuplicateSmarts<OEShape::OEOverlapPrepOptions::ClearDuplicateSmarts>`
   * :oe:meth:`GetRemoveColor<OEShape::OEOverlapPrepOptions::GetRemoveColor>` and
     :oe:meth:`SetRemoveColor<OEShape::OEOverlapPrepOptions::SetRemoveColor>`
   * :oe:meth:`GetRemoveDuplicate<OEShape::OEOverlapPrepOptions::GetRemoveDuplicate>` and
     :oe:meth:`SetRemoveDuplicate<OEShape::OEOverlapPrepOptions::SetRemoveDuplicate>`
   * :oe:meth:`GetUseHydrogens<OEShape::OEOverlapPrepOptions::GetUseHydrogens>` and
     :oe:meth:`SetUseHydrogens<OEShape::OEOverlapPrepOptions::SetUseHydrogens>`
   * :oe:meth:`GetColorForceField<OEShape::OEOverlapPrepOptions::GetColorForceField>` and
     :oe:meth:`SetColorForceField<OEShape::OEOverlapPrepOptions::SetColorForceField>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEOverlapPrepOptions(const bool loadColorFF = true)
            OEOverlapPrepOptions(const OEOverlapPrepOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEOverlapPrepOptions(loadColorFF: bool = True) -> OEOverlapPrepOptions
            OEOverlapPrepOptions(argOpts: OEOverlapPrepOptions) -> OEOverlapPrepOptions

      Default and copy constructors.

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

      .. oe:api::

         OEOverlapPrepOptions &operator=(const OEOverlapPrepOptions&)


   .. _OEShape_OEOverlapPrepOptions_GetAssignBondiRadii:

      Assignment operator.



   .. oe:method:: GetAssignBondiRadii

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

         .. oe:api::

            bool GetAssignBondiRadii() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignBondiRadii() -> bool

      See :oe:meth:`SetAssignBondiRadii<OEShape::OEOverlapPrepOptions::SetAssignBondiRadii>` method.

   .. _OEShape_OEOverlapPrepOptions_GetAssignColor:


   .. oe:method:: GetAssignColor

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

         .. oe:api::

            bool GetAssignColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetAssignColor() -> bool

      See :oe:meth:`SetAssignColor<OEShape::OEOverlapPrepOptions::SetAssignColor>` method.

   .. _OEShape_OEOverlapPrepOptions_GetRemoveColor:


   .. oe:method:: GetRemoveColor

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

         .. oe:api::

            bool GetRemoveColor() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveColor() -> bool

      See :oe:meth:`SetRemoveColor<OEShape::OEOverlapPrepOptions::SetRemoveColor>` method.


   .. _OEShape_OEOverlapPrepOptions_GetDuplicateDistance:


   .. oe:method:: GetDuplicateDistance

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

         .. oe:api::

            float GetDuplicateDistance() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateDistance() -> float

      See :oe:meth:`SetDuplicateDistance<OEShape::OEOverlapPrepOptions::SetDuplicateDistance>` method.

   .. _OEShape_OEOverlapPrepOptions_GetRemoveDuplicate:


   .. oe:method:: GetRemoveDuplicate

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

         .. oe:api::

            bool GetRemoveDuplicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetRemoveDuplicate() -> bool

      See :oe:meth:`SetRemoveDuplicate<OEShape::OEOverlapPrepOptions::SetRemoveDuplicate>` method.

   .. _OEShape_OEOverlapPrepOptions_GetUseHydrogens:


   .. oe:method:: GetUseHydrogens

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

         .. oe:api::

            bool GetUseHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseHydrogens() -> bool

      See :oe:meth:`SetUseHydrogens<OEShape::OEOverlapPrepOptions::SetUseHydrogens>` method.


   .. _OEShape_OEOverlapPrepOptions_GetColorForceField:


   .. oe:method:: GetColorForceField

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

         .. oe:api::

            const OEColorForceField& GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      See :oe:meth:`SetColorForceField<OEShape::OEOverlapPrepOptions::SetColorForceField>` method.


   .. _OEShape_OEOverlapPrepOptions_SetAssignBondiRadii:

   .. oe:method:: SetAssignBondiRadii

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

         .. oe:api::

            void SetAssignBondiRadii(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignBondiRadii(value: bool) -> bool

      Sets if **Bondi Radii** should be assigned. If true, Bondi radii 
      would be assigned to all atoms during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. 
      Default: `False`.


   .. _OEShape_OEOverlapPrepOptions_SetAssignColor:

   .. oe:method:: SetAssignColor

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

         .. oe:api::

            void SetAssignColor(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAssignColor(value: bool) -> bool

      Sets if **color atoms** should be assigned. If true, color atoms would be 
      assigned during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`.
      Color atoms are only assigned to molecules that currently do not have any color atoms.
      To re-assign color atoms to all molecules, use :oe:meth:`SetRemoveColor<OEShape::OEOverlapPrepOptions::SetRemoveColor>` 
      to `True`. Default: `True`.


   .. _OEShape_OEOverlapPrepOptions_SetRemoveColor:

   .. oe:method:: SetRemoveColor

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

         .. oe:api::

            bool SetRemoveColor(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveColor(value: bool) -> bool

      Sets if existing color atoms should be removed. If true, existing color atoms
      are removed during :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. Default: `False`.


   .. _OEShape_OEOverlapPrepOptions_SetDuplicateDistance:

   .. oe:method:: SetDuplicateDistance

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

         .. oe:api::

            bool SetDuplicateDistance(const float)

      .. oe:language:: python

         .. oe:api:: python

            SetDuplicateDistance(value: float) -> bool

      Sets the threshold distance for duplicate removal of color atoms. The acceptable 
      range is between `0.0` and `1.0`. Default `0.0`.


   .. _OEShape_OEOverlapPrepOptions_SetRemoveDuplicate:

   .. oe:method:: SetRemoveDuplicate

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

         .. oe:api::

            bool SetRemoveDuplicate(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRemoveDuplicate(value: bool) -> bool

      Sets if duplicate color atoms should be removed. Default `True`.


   .. _OEShape_OEOverlapPrepOptions_SetUseHydrogens:

   .. oe:method:: SetUseHydrogens

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

         .. oe:api::

            bool SetUseHydrogens(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseHydrogens(value: bool) -> bool

      Sets if explicit hydrogen atoms should be used. If true, explicit hydrogen atoms would be
      created during the :oe:meth:`Prep<OEShape::OEOverlapPrep::Prep>`. If false, all hydrogen
      atoms would be removed. Default `False`.

   .. _OEShape_OEOverlapPrepOptions_ColorForceField:

   .. oe:method:: SetColorForceField

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

         .. oe:api::

            bool SetColorForceField(const OEColorForceField&)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(value: OEColorForceField) -> bool

      Sets the color force field to be used. By default, the `ImplicitMillsDean`
      color force field is used.


   .. _OEShape_OEOverlapPrepOptions_AddDuplicateSmarts:

   .. oe:method:: AddDuplicateSmarts

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

         .. oe:api::

            bool AddDuplicateSmarts(const std::string& smarts)

      .. oe:language:: python

         .. oe:api:: python

            AddDuplicateSmarts(smarts: str) -> bool

      Adds a SMARTS pattern used to identify duplicate color atoms.
      Returns `false` if the SMARTS pattern already exists in the list, `true` otherwise.
      By default, SMARTS patterns for Cubane and Adamantane are included.


   .. _OEShape_OEOverlapPrepOptions_GetDuplicateSmarts:

   .. oe:method:: GetDuplicateSmarts

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

         .. oe:api::

            const std::vector<std::string>& GetDuplicateSmarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateSmarts() -> OEStringVector

      Returns the list of SMARTS patterns used for identifying duplicate color atoms.
      See :oe:meth:`AddDuplicateSmarts<OEShape::OEOverlapPrepOptions::AddDuplicateSmarts>` method.


   .. _OEShape_OEOverlapPrepOptions_ClearDuplicateSmarts:

   .. oe:method:: ClearDuplicateSmarts

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

         .. oe:api::

            bool ClearDuplicateSmarts()

      .. oe:language:: python

         .. oe:api:: python

            ClearDuplicateSmarts() -> bool

      Removes all SMARTS patterns from the duplicate detection list.
      See :oe:meth:`AddDuplicateSmarts<OEShape::OEOverlapPrepOptions::AddDuplicateSmarts>` method.
