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

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEFragBuilder, FragBuilder


.. _OEConfGen_OEFragBuilder:

.. oe:class:: OEFragBuilder

   .. oe:api::

      class OEFragBuilder

   This class defines an interface for generating 3D structures
   of molecule fragments using a distance geometry based algorithm.
   A fragment is a building block that is used for initial
   3D structure generation of molecules.

   .. seealso::

      * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class

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


   .. oe:method:: Constructors

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

         .. oe:api::

            OEFragBuilder(const OEFragBuilderOptions& argOpts = OEFragBuilderOptions())
            OEFragBuilder(const OEFragBuilder&)

      .. oe:language:: python

         .. oe:api:: python

            OEFragBuilder(argOpts: OEFragBuilderOptions = OEFragBuilderOptions()) -> OEFragBuilder
            OEFragBuilder(arg2: OEFragBuilder) -> OEFragBuilder

      Default and copy constructors.

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

      .. oe:api::

         OEFragBuilder &operator=(const OEFragBuilder&)

      Assignment operator.

   .. _OEConfGen_OEFragBuilder_Build:


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

   .. _OEConfGen_OEFragBuilder_GetOptions:


   .. oe:method:: GetOptions

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

         .. oe:api::

            const OEFragBuilderOptions& GetOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetOptions() -> OEFragBuilderOptions

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

   .. _OEConfGen_OEFragBuilder_SetOptions:

   .. oe:method:: SetOptions

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

         .. oe:api::

            void SetOptions(OEFragBuilderOptions& argOpts)

      .. oe:language:: python

         .. oe:api:: python

            SetOptions(argOpts: OEFragBuilderOptions) -> None

      Sets :oe:cls:`options<OEConfGen::OEFragBuilderOptions>` for building
      the fragment structures.
      Default: :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` with
      :oe:const:`OEConfGen::OEFragBuilderMode::Default` mode.

      .. seealso::

         * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class
