.. oe:namespace:: OESzmap

.. meta::
   :keywords: OESzmapEngineOptions, SzmapEngineOptions


.. _OESzmap_OESzmapEngineOptions:

.. oe:class:: OESzmapEngineOptions

   .. oe:api::


      class OESzmapEngineOptions

   An object used to set
   one or more options when constructing an :ref:`OESzmapEngine <OESzmap_OESzmapEngine>`.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-COMBINE-OPTIONS

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-COMBINE-OPTIONS

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-COMBINE-OPTIONS

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-COMBINE-OPTIONS

   When returned by :oe:meth:`OESzmap::OESzmapEngine::GetOptions`, can be used
   to determine the settings used for a given set of calculations.

   .. oe:source:: SzmapCalcs.cpp
      :language: c++
      :noindent:
      :frag:     SNIPPET-GET-OPTIONS

   .. oe:source:: SzmapCalcs.py
      :language: python
      :noindent:
      :frag:     SNIPPET-GET-OPTIONS

   .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`


   .. oe:source:: SzmapCalcs.java
      :language: java
      :noindent:
      :frag:     SNIPPET-GET-OPTIONS

   .. oe:source:: SzmapCalcs.cs
      :language: csharp
      :noindent:
      :frag:     SNIPPET-GET-OPTIONS

   .. oe:method:: Constructors

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

         .. oe:api::

            OESzmapEngineOptions()
            OESzmapEngineOptions(const OESzmapEngineOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OESzmapEngineOptions() -> OESzmapEngineOptions
            OESzmapEngineOptions(rhs: OESzmapEngineOptions) -> OESzmapEngineOptions

      Default and copy constructors. The default :ref:`OESzmapEngineOptions <OESzmap_OESzmapEngineOptions>`
      object defines the probe to be a standard *SZMAP* water with 60 orientations.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINEOPTIONS-OBJECT

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINEOPTIONS-OBJECT

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINEOPTIONS-OBJECT

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-CREATE-SZMAPENGINEOPTIONS-OBJECT

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

      .. oe:api::

         OESzmapEngineOptions &operator=(const OESzmapEngineOptions &rhs)

      Assignment operator.

   .. oe:method:: GetMaskCutoff

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

         .. oe:api::

            double GetMaskCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaskCutoff() -> float

      Returns the energy cutoff (in kcal/mol) defining a *clash*
      (by default, 0.0; see :oe:func:`OESzmap::OEIsClashing`
      and :oe:meth:`OESzmap::OESzmapEngineOptions::SetMaskCutoff`).
      A *clash* means
      every orientation of the probe had a combined
      :oe:const:`OESzmap::OEComponent::Interaction`
      + :oe:const:`OESzmap::OEComponent::VDW`
      energy total greater than the cutoff.

   .. oe:method:: GetProbe

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

         .. oe:api::

            const OEChem::OEMCMolBase& GetProbe() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbe() -> OEMol

      Returns a reference to the current multi-conformer probe molecule
      (see :oe:meth:`OESzmap::OESzmapEngineOptions::SetProbe`).

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GET-PROBE

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GET-PROBE

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GET-PROBE

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GET-PROBE

   .. oe:method:: GetProbeMol

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

         .. oe:api::

            void GetProbeMol(OEChem::OEMolBase& outputMol,
                             unsigned int orientation = 0u) const

      .. oe:language:: python

         .. oe:api:: python

            GetProbeMol(outputMol: Union[OEGraphMol,OEMol,OEQMol],
                        orientation: int = 0) -> None

      Updates ``outputMol`` to contain a specific orientation of
      the current multi-conformer probe
      (see :oe:meth:`OESzmap::OESzmapEngineOptions::SetProbe`).
      By default, the first orientation is returned.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-GETPROBEMOL

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-GETPROBEMOL

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-GETPROBEMOL

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-GETPROBEMOL

   .. oe:method:: GetProbeName

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

         .. oe:api::

            const char* GetProbeName() const

      .. oe:language:: python

         .. oe:api:: python

            GetProbeName() -> str

      Returns the standard name of the current probe type (e.g. ``"water"``).

   .. oe:method:: NumOrientations

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

         .. oe:api::

            unsigned int NumOrientations() const

      .. oe:language:: python

         .. oe:api:: python

            NumOrientations() -> int

      Returns the number of orientations for the current probe
      (see :oe:meth:`OESzmap::OESzmapEngineOptions::SetProbe`).

   .. oe:method:: SetMaskCutoff

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

         .. oe:api::

            OESzmapEngineOptions& SetMaskCutoff(double cutoff)

      .. oe:language:: python

         .. oe:api:: python

            SetMaskCutoff(cutoff: float) -> OESzmapEngineOptions

      Set the energy cutoff (in kcal/mol) defining a *clash*
      (by default, 0.0; see :oe:func:`OESzmap::OEIsClashing`
      and :oe:meth:`OESzmap::OESzmapEngineOptions::GetMaskCutoff`).
      A *clash* means
      every orientation of the probe had a combined
      :oe:const:`OESzmap::OEComponent::Interaction`
      + :oe:const:`OESzmap::OEComponent::VDW`
      energy total greater than the cutoff.

   .. oe:method:: SetProbe

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

         .. oe:api::

            OESzmapEngineOptions& SetProbe(unsigned int numOrientations)

      .. oe:language:: python

         .. oe:api:: python

            SetProbe(numOrientations: int) -> OESzmapEngineOptions

      Define the current multi-conformation probe molecule to be
      a standard *SZMAP* water molecule with the specified number
      of orientations (see :ref:`chapter_water_model`
      for more information on the geometry and charges used).

      If ``numOrientations`` is set to 24, 60, 216, 360, or 648
      then the set of orientations will be symmetric. Otherwise,
      it will include random orientations
      and may have lopsided gaps in coverage. For most purposes, 60 is the
      minimum required for reliable energy calculations and 360 generates
      higher-precision results, although with a speed penalty due
      to the additional *Zap* calculations.

      .. oe:source:: SzmapCalcs.cpp
         :language: c++
         :noindent:
         :frag:     SNIPPET-SETPROBE

      .. oe:source:: SzmapCalcs.py
         :language: python
         :noindent:
         :frag:     SNIPPET-SETPROBE

      .. :oe:language:: python

        :ref:`Full listing. <listing-SzmapCalcs.py>`

      .. oe:source:: SzmapCalcs.java
         :language: java
         :noindent:
         :frag:     SNIPPET-SETPROBE

      .. oe:source:: SzmapCalcs.cs
         :language: csharp
         :noindent:
         :frag:     SNIPPET-SETPROBE

      The default :ref:`OESzmapEngineOptions <OESzmap_OESzmapEngineOptions>`
      standard *SZMAP* water has 60 orientations.


