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

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMacrocycleBuilder, MacrocycleBuilder


.. _OEConfGen_OEMacrocycleBuilder:

.. oe:class:: OEMacrocycleBuilder

   .. oe:api::

      class OEMacrocycleBuilder

   This class defines an interface for generating 3D structures
   of macrocyclic molecules.  Macrocycle structures are generated
   by first creating an initial structure using distance geometry, followed by
   a force field based refinement of the structure.

   .. seealso::

      * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_single_conf_macrocycle` example

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


   .. oe:method:: Constructors

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

         .. oe:api::

            OEMacrocycleBuilder(const OEMacrocycleBuilderOptions& argOpts = OEMacrocycleBuilderOptions())
            OEMacrocycleBuilder(const OEMacrocycleBuilder&)

      .. oe:language:: python

         .. oe:api:: python

            OEMacrocycleBuilder(argOpts: OEMacrocycleBuilderOptions = OEMacrocycleBuilderOptions()) -> OEMacrocycleBuilder
            OEMacrocycleBuilder(arg2: OEMacrocycleBuilder) -> OEMacrocycleBuilder

      Default and copy constructors.

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

      .. oe:api::

         OEMacrocycleBuilder &operator=(const OEMacrocycleBuilder&)

      Assignment operator.

   .. oe:method:: Build

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

         .. oe:api::

            unsigned Build(OEChem::OEMolBase&) const
            unsigned Build(OEChem::OEMCMolBase&) const

      .. oe:language:: python

         .. oe:api:: python

            Build(mol: Union[OEGraphMol,OEQMol]) -> int
            Build(mol: OEMol) -> int

      Generates a 3D structure for a macrocycle 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 OEMacrocycleBuilderOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEMacrocycleBuilderOptions

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

   .. oe:method:: SetOptions

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

         .. oe:api::

            void SetOptions(OEMacrocycleBuilderOptions& argOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(argOpts: OEMacrocycleBuilderOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEMacrocycleBuilderOptions>` for building the molecule 3D structures.

   .. seealso::

      * :ref:`OEMacrocycleBuilderOptions <OEConfGen_OEMacrocycleBuilderOptions>` class
