.. oe:namespace:: OEDocking

.. meta::
   :keywords: OEMakeReceptorOptions, MakeReceptorOptions


.. _OEDocking_OEMakeReceptorOptions:

.. oe:class:: OEMakeReceptorOptions

   .. oe:api::

      class OEMakeReceptorOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for *OEMakeReceptor*.

   The :ref:`OEMakeReceptorOptions <OEDocking_OEMakeReceptorOptions>` class defines the following public methods:
    * :oe:meth:`GetAutoConstraints<OEDocking::OEMakeReceptorOptions::GetAutoConstraints>` and
      :oe:meth:`SetAutoConstraints<OEDocking::OEMakeReceptorOptions::SetAutoConstraints>`
    * :oe:meth:`GetBoxExtension<OEDocking::OEMakeReceptorOptions::GetBoxExtension>` and
      :oe:meth:`SetBoxExtension<OEDocking::OEMakeReceptorOptions::SetBoxExtension>`
    * :oe:meth:`GetBoxMol<OEDocking::OEMakeReceptorOptions::GetBoxMol>` and
      :oe:meth:`SetBoxMol<OEDocking::OEMakeReceptorOptions::SetBoxMol>`
    * :oe:meth:`GetNegativeImageType<OEDocking::OEMakeReceptorOptions::GetNegativeImageType>` and
      :oe:meth:`SetNegativeImageType<OEDocking::OEMakeReceptorOptions::SetNegativeImageType>`
    * :oe:meth:`GetTargetMask<OEDocking::OEMakeReceptorOptions::GetTargetMask>` and
      :oe:meth:`SetTargetMask<OEDocking::OEMakeReceptorOptions::SetTargetMask>`
    * :oe:meth:`GetTargetPred<OEDocking::OEMakeReceptorOptions::GetTargetPred>` and
      :oe:meth:`SetTargetPred<OEDocking::OEMakeReceptorOptions::SetTargetPred>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEMakeReceptorOptions()
            OEMakeReceptorOptions(const OEMakeReceptorOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMakeReceptorOptions() -> OEMakeReceptorOptions
            OEMakeReceptorOptions(arg2: OEMakeReceptorOptions) -> OEMakeReceptorOptions

      Default and copy constructors.

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

      .. oe:api::

         OEMakeReceptorOptions &operator=(const OEMakeReceptorOptions &)

      Assignment operator.


   .. oe:method:: GetAutoConstraints

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

         .. oe:api::

            bool GetAutoConstraints() const

      .. oe:language:: python

         .. oe:api:: python

            GetAutoConstraints() -> bool

      See :oe:meth:`SetAutoConstraints<OEDocking::OEMakeReceptorOptions::SetAutoConstraints>` method.

   .. oe:method:: GetBoxExtension

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

         .. oe:api::

            double GetBoxExtension() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxExtension() -> float

      See :oe:meth:`SetBoxExtension<OEDocking::OEMakeReceptorOptions::SetBoxExtension>` method.

   .. oe:method:: GetBoxMol

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

         .. oe:api::

            const OEChem::OEMolBase& GetBoxMol() const

      .. oe:language:: python

         .. oe:api:: python

            GetBoxMol() -> OEGraphMol

      See :oe:meth:`SetBoxMol<OEDocking::OEMakeReceptorOptions::SetBoxMol>` method.

   .. oe:method:: GetNegativeImageType

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

         .. oe:api::

            unsigned GetNegativeImageType() const

      .. oe:language:: python

         .. oe:api:: python

            GetNegativeImageType() -> int

      See :oe:meth:`SetNegativeImageType<OEDocking::OEMakeReceptorOptions::SetNegativeImageType>` method.

   .. oe:method:: GetTargetMask

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

         .. oe:api::

            unsigned GetTargetMask() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetMask() -> int

      See :oe:meth:`SetTargetMask<OEDocking::OEMakeReceptorOptions::SetTargetMask>` method.

   .. oe:method:: GetTargetPred

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

         .. oe:api::

            std::string GetTargetPred() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetPred() -> str

      See :oe:meth:`SetTargetPred<OEDocking::OEMakeReceptorOptions::SetTargetPred>` method.


   ..   _OEDocking_SetAutoConstraints:

   .. oe:method:: SetAutoConstraints

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

         .. oe:api::

            bool SetAutoConstraints(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetAutoConstraints(value: bool) -> bool

      Sets flag if protein constraints should be automatically detected and added to the receptor. The auto 
      generated constraints are kept as disabled. Default: True.

   .. oe:method:: SetBoxExtension

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

         .. oe:api::

            bool SetBoxExtension(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetBoxExtension(value: float) -> bool

      Sets the **amount** for each box face to be extended relative to the minimum box enclosing the 
      :oe:meth:`BoxMol<OEDocking::OEMakeReceptorOptions::SetBoxMol>`. Default: 0.0.

   ..   _OEDocking_SetBoxMol:

   .. oe:method:: SetBoxMol

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

         .. oe:api::

            bool SetBoxMol(const OEChem::OEMolBase& value)

      .. oe:language:: python

         .. oe:api:: python

            SetBoxMol(value: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Sets the **molecule** representing the active site on the proteinStructure. The minimum size box that 
      encloses the molecule plus any desired :oe:meth:`extension<OEDocking::OEMakeReceptorOptions::SetBoxExtension>`
      is used as the active site encloser.

   .. oe:method:: SetNegativeImageType

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

         .. oe:api::

            bool SetNegativeImageType(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetNegativeImageType(value: int) -> bool

      Sets the **negative image type** to be generated. Allowed methods are defined in the
      :oe:constns:`OEDocking::OENegativeImageType` namespace.
      Default is :oe:const:`OEDocking::OENegativeImageType::StandardShape`.

   .. oe:method:: SetTargetMask

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

         .. oe:api::

            bool SetTargetMask(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetTargetMask(value: int) -> bool

      Sets the **target mask** specifying the components of the design unit to be used as receptor target.
      Allowed methods are defined in the :ref:`OEDesignUnitComponents <OEBio_OEDesignUnitComponents>` namespace.
      Default: :ref:`targetComplexNoSolvent <OEBio_targetComplexNoSolvent>`.

   ..   _OEDocking_SetTargetPred:

   .. oe:method:: SetTargetPred

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

         .. oe:api::

            bool SetTargetPred(const std::string)

      .. oe:language:: python

         .. oe:api:: python

            SetTargetPred(value: str) -> bool

      Sets the **target predicate** which subsets the components in the TargetMask from the design unit if it matches
      anything in a specific component.
