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

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMacrocycleOmegaOptions, MacrocycleOmegaOptions


.. _OEConfGen_OEMacrocycleOmegaOptions:

.. oe:class:: OEMacrocycleOmegaOptions

   .. oe:api::

      class OEMacrocycleOmegaOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for generating an
   ensemble of macrocycle molecule conformers.

   .. seealso::

      * :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` class
      * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class
      * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_macrocycle` example

   The :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class defines the following public methods:
    * :oe:meth:`GetEnergyWindow<OEConfGen::OEMacrocycleOmegaOptions::GetEnergyWindow>` and
      :oe:meth:`SetEnergyWindow<OEConfGen::OEMacrocycleOmegaOptions::SetEnergyWindow>`
    * :oe:meth:`GetIterCycleSize<OEConfGen::OEMacrocycleOmegaOptions::GetIterCycleSize>` and
      :oe:meth:`SetIterCycleSize<OEConfGen::OEMacrocycleOmegaOptions::SetIterCycleSize>`
    * :oe:meth:`GetMacrocycleBuilderOptions<OEConfGen::OEMacrocycleOmegaOptions::GetMacrocycleBuilderOptions>` and
      :oe:meth:`SetMacrocycleBuilderOptions<OEConfGen::OEMacrocycleOmegaOptions::SetMacrocycleBuilderOptions>`
    * :oe:meth:`GetMaxConfs<OEConfGen::OEMacrocycleOmegaOptions::GetMaxConfs>` and
      :oe:meth:`SetMaxConfs<OEConfGen::OEMacrocycleOmegaOptions::SetMaxConfs>`
    * :oe:meth:`GetMaxIter<OEConfGen::OEMacrocycleOmegaOptions::GetMaxIter>` and
      :oe:meth:`SetMaxIter<OEConfGen::OEMacrocycleOmegaOptions::SetMaxIter>`
    * :oe:meth:`GetSliceEnsembleOptions<OEConfGen::OEMacrocycleOmegaOptions::GetSliceEnsembleOptions>` and
      :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OEMacrocycleOmegaOptions::SetSliceEnsembleOptions>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMacrocycleOmegaOptions()
            OEMacrocycleOmegaOptions(const OEMacrocycleOmegaOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMacrocycleOmegaOptions() -> OEMacrocycleOmegaOptions
            OEMacrocycleOmegaOptions(arg2: OEMacrocycleOmegaOptions) -> OEMacrocycleOmegaOptions

      Default and copy constructors.

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

      .. oe:api::

         OEMacrocycleOmegaOptions &operator=(const OEMacrocycleOmegaOptions &)

      Assignment operator.

   .. oe:method:: GetEnergyWindow

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

         .. oe:api::

            double GetEnergyWindow() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnergyWindow() -> float

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OEMacrocycleOmegaOptions::SetEnergyWindow>` method.

   .. oe:method:: GetIterCycleSize

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

         .. oe:api::

            unsigned int GetIterCycleSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetIterCycleSize() -> int

      See the :oe:meth:`SetIterCycleSize<OEConfGen::OEMacrocycleOmegaOptions::SetIterCycleSize>` method.

   .. oe:method:: GetMacrocycleBuilderOptions

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

         .. oe:api::

            OEMacrocycleBuilderOptions& GetMacrocycleBuilderOptions()
            const OEMacrocycleBuilderOptions& GetMacrocycleBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetMacrocycleBuilderOptions() -> OEMacrocycleBuilderOptions

      See the :oe:meth:`SetMacrocycleBuilderOptions<OEConfGen::OEMacrocycleOmegaOptions::SetMacrocycleBuilderOptions>` method.

   .. oe:method:: GetMaxConfs

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

         .. oe:api::

            unsigned GetMaxConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxConfs() -> int

      See the :oe:meth:`SetMaxConfs<OEConfGen::OEMacrocycleOmegaOptions::SetMaxConfs>` method.

   .. oe:method:: GetMaxIter

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

         .. oe:api::

            unsigned int GetMaxIter() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxIter() -> int

      See the :oe:meth:`SetMaxIter<OEConfGen::OEMacrocycleOmegaOptions::SetMaxIter>` method.

   .. oe:method:: GetSliceEnsembleOptions

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

         .. oe:api::

            OESliceEnsembleOptions& GetSliceEnsembleOptions()
            const OESliceEnsembleOptions& GetSliceEnsembleOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetSliceEnsembleOptions() -> OESliceEnsembleOptions

      See :oe:meth:`SetSliceEnsembleOptions<OEConfGen::OEMacrocycleOmegaOptions::SetSliceEnsembleOptions>` method.

   .. oe:method:: SetEnergyWindow

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

         .. oe:api::

            bool SetEnergyWindow(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetEnergyWindow(value: float) -> bool

      See the :oe:meth:`SetEnergyWindow<OEConfGen::OESliceEnsembleOptions::SetEnergyWindow>` method.
      Default: 20

   .. oe:method:: SetIterCycleSize

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

         .. oe:api::

            bool SetIterCycleSize(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetIterCycleSize(value: int) -> bool

      Sets the **number of new conformers** that are to be attempted
      before checking if a new minimum was found. Conformer generation finishes
      if no new minimum is found during an iteration cycle.
      Default: 100

   .. oe:method:: SetMacrocycleBuilderOptions

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

         .. oe:api::

            void SetMacrocycleBuilderOptions(const OEMacrocycleBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetMacrocycleBuilderOptions(opts: OEMacrocycleBuilderOptions) -> None

      Sets the :oe:cls:`options<OEConfGen::OEMacrocycleBuilderOptions>`
      that are to be used for generating new conformers.

      .. seealso::

          * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class

   ..   _OEConfGen_SetMaxConfs:

   .. oe:method:: SetMaxConfs

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

         .. oe:api::

            bool SetMaxConfs(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxConfs(value: int) -> bool

      See the :oe:meth:`SetMaxConfs<OEConfGen::OESliceEnsembleOptions::SetMaxConfs>` method.
      Default: 400

   .. oe:method:: SetMaxIter

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

         .. oe:api::

            bool SetMaxIter(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxIter(value: int) -> bool

      Sets the **maximum number of iteration cycles** are to be attempted.
      If the desired number of unique conformers are already generated in the ensemble,
      conformer generation will terminate before reaching this number.
      Default: 2000

   .. oe:method:: SetSliceEnsembleOptions

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

         .. oe:api::

            void SetSliceEnsembleOptions(const OESliceEnsembleOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetSliceEnsembleOptions(opts: OESliceEnsembleOptions) -> None

      Sets the :oe:cls:`options<OEConfGen::OESliceEnsembleOptions>` that are to be used for removing duplicate
      conformers during macrocycle conformer ensemble generation.

      .. seealso::

         * :ref:`OESliceEnsembleOptions <OEConfGen_OESliceEnsembleOptions>` class
