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

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMacrocycleOmega, MacrocycleOmega


.. _OEConfGen_OEMacrocycleOmega:

.. oe:class:: OEMacrocycleOmega

   .. oe:api::

      class OEMacrocycleOmega

   This class defines an interface for generating ensembles of conformers
   of macrocycle molecules.

   .. seealso::

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

   .. admonition:: Code Examples

      * :ref:`section_examples_macrocycle` example

   The :ref:`OEMacrocycleOmega <OEConfGen_OEMacrocycleOmega>` class defines the following public methods:
    * :oe:meth:`Build<OEConfGen::OEMacrocycleOmega::Build>`
    * :oe:meth:`GetOptions<OEConfGen::OEMacrocycleOmega::GetOptions>` and
      :oe:meth:`SetOptions<OEConfGen::OEMacrocycleOmega::SetOptions>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMacrocycleOmega(const OEMacrocycleOmegaOptions& argOpts = OEMacrocycleOmegaOptions())
            OEMacrocycleOmega(const OEMacrocycleOmega&)

      .. oe:language:: python

         .. oe:api:: python

            OEMacrocycleOmega(argOpts: OEMacrocycleOmegaOptions = OEMacrocycleOmegaOptions()) -> OEMacrocycleOmega
            OEMacrocycleOmega(arg2: OEMacrocycleOmega) -> OEMacrocycleOmega

      Default and copy constructors.

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

      .. oe:api::

         OEMacrocycleOmega &operator=(const OEMacrocycleOmega&)

      Assignment operator.

   .. oe:method:: Build

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

         .. oe:api::

            unsigned Build(OEChem::OEMCMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: OEMol) -> int

      Generates conformer ensemble for a macrocyclic molecule. Returns
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace.

   .. oe:method:: GetOptions

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

         .. oe:api::

            const OEMacrocycleOmegaOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEMacrocycleOmegaOptions

      See the :oe:meth:`SetOptions<OEConfGen::OEMacrocycleOmega::SetOptions>` method.

   .. oe:method:: SetOptions

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

         .. oe:api::

            void SetOptions(OEMacrocycleOmegaOptions& argOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(argOpts: OEMacrocycleOmegaOptions) -> None

      Sets the :oe:cls:`options<OEConfGen::OEMacrocycleOmegaOptions>` for generating a conformer ensemble.

      .. seealso::

          * :ref:`OEMacrocycleOmegaOptions <OEConfGen_OEMacrocycleOmegaOptions>` class
