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

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEConformerBuilder, ConformerBuilder


.. _OEConfGen_OEConformerBuilder:

.. oe:class:: OEConformerBuilder

   .. oe:api::

      class OEConformerBuilder

   This class defines an interface for generating 3D structures of small
   molecules. This class differs from :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` in that
   it makes an effort to ensure that the generated conformer is clash free.
   However, this is faster than :ref:`OEOmega <OEConfGen_OEOmega>` for generating a
   single conformer, as this method does not search for the lowest energy conformer.

   .. admonition:: Code Examples

      * :ref:`section_examples_single_conformer` example

   The :ref:`OEConformerBuilder <OEConfGen_OEConformerBuilder>` class defines the following public methods:
    * :oe:meth:`Build<OEConfGen::OEConformerBuilder::Build>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEConformerBuilder()
            OEConformerBuilder(const OEConformerBuilder&)

      .. oe:language:: python

         .. oe:api:: python

            OEConformerBuilder() -> OEConformerBuilder
            OEConformerBuilder(arg2: OEConformerBuilder) -> OEConformerBuilder

      Default and copy constructors.

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

      .. oe:api::

         OEConformerBuilder &operator=(const OEConformerBuilder&)

      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 of a small molecule. Returns 
      :oe:const:`OEConfGen::OEOmegaReturnCode::Success` if 
      the process succeeds, otherwise returns an error code from the
      :oe:constns:`OEConfGen::OEOmegaReturnCode` namespace.
