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

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMacrocycleBuilderOptions, MacrocycleBuilderOptions


.. _OEConfGen_OEMacrocycleBuilderOptions:

.. oe:class:: OEMacrocycleBuilderOptions

   .. oe:api::

      class OEMacrocycleBuilderOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for generating
   3D structures of macrocycle molecules.

   .. seealso::

      * :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class
      * :ref:`OEMacrocycleBuilder <OEConfGen_OEMacrocycleBuilder>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_single_conf_macrocycle` example

   The :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class defines the following public methods:
    * :oe:meth:`GetDielectricConst<OEConfGen::OEMacrocycleBuilderOptions::GetDielectricConst>` and
      :oe:meth:`SetDielectricConst<OEConfGen::OEMacrocycleBuilderOptions::SetDielectricConst>`
    * :oe:meth:`GetRandomSeed<OEConfGen::OEMacrocycleBuilderOptions::GetRandomSeed>` and
      :oe:meth:`SetRandomSeed<OEConfGen::OEMacrocycleBuilderOptions::SetRandomSeed>`
    * :oe:meth:`GetRefTolerance<OEConfGen::OEMacrocycleBuilderOptions::GetRefTolerance>` and
      :oe:meth:`SetRefTolerance<OEConfGen::OEMacrocycleBuilderOptions::SetRefTolerance>`
    * :oe:meth:`GetSkipRefinement<OEConfGen::OEMacrocycleBuilderOptions::GetSkipRefinement>` and
      :oe:meth:`SetSkipRefinement<OEConfGen::OEMacrocycleBuilderOptions::SetSkipRefinement>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMacrocycleBuilderOptions()
            OEMacrocycleBuilderOptions(const OEMacrocycleBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMacrocycleBuilderOptions() -> OEMacrocycleBuilderOptions
            OEMacrocycleBuilderOptions(arg2: OEMacrocycleBuilderOptions) -> OEMacrocycleBuilderOptions

      Default and copy constructors.

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

      .. oe:api::

         OEMacrocycleBuilderOptions &operator=(const OEMacrocycleBuilderOptions &)

      Assignment operator.

   .. oe:method:: GetDielectricConst

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

         .. oe:api::

            double GetDielectricConst() const

      .. oe:language:: python

         .. oe:api:: python

            GetDielectricConst() -> float

      See the :oe:meth:`SetDielectricConst<OEConfGen::OEMacrocycleBuilderOptions::SetDielectricConst>` method.

   .. oe:method:: GetRandomSeed

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

         .. oe:api::

            unsigned GetRandomSeed() const

      .. oe:language:: python

         .. oe:api:: python

            GetRandomSeed() -> int

      See the :oe:meth:`SetRandomSeed<OEConfGen::OEMacrocycleBuilderOptions::SetRandomSeed>` method.

   .. oe:method:: GetRefTolerance

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

         .. oe:api::

            double GetRefTolerance() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefTolerance() -> float

      See the :oe:meth:`SetRefTolerance<OEConfGen::OEMacrocycleBuilderOptions::SetRefTolerance>` method.

   .. oe:method:: GetSkipRefinement

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

         .. oe:api::

            bool GetSkipRefinement() const

      .. oe:language:: python

         .. oe:api:: python

            GetSkipRefinement() -> bool

      See the :oe:meth:`SetSkipRefinement<OEConfGen::OEMacrocycleBuilderOptions::SetSkipRefinement>` method.

   .. oe:method:: SetDielectricConst

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

         .. oe:api::

            bool SetDielectricConst(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetDielectricConst(value: float) -> bool

      Sets the **dielectric constant of the solvent** to be used
      in the refinement stage.
      Default: 80.0

   .. oe:method:: SetRandomSeed

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

         .. oe:api::

            bool SetRandomSeed(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetRandomSeed(value: int) -> bool

      Sets the **random seed** for initial structure generation.
      Default: 0

   .. oe:method:: SetRefTolerance

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

         .. oe:api::

            bool SetRefTolerance(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetRefTolerance(value: float) -> bool

      Sets the **tolerance criteria** for the optimizer during refinement.
      Default: 0.001

   .. oe:method:: SetSkipRefinement

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

         .. oe:api::

            bool SetSkipRefinement(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSkipRefinement(value: bool) -> bool

      Sets whether **refinement** of the generated initial structure
      should be **performed or skipped**. If true, refinement is skipped.
      Default: False
