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

.. oe:namespace:: OEConfGen

.. meta::
   :keywords: OEMolBuilderOptions, MolBuilderOptions


.. _OEConfGen_OEMolBuilderOptions:

.. oe:class:: OEMolBuilderOptions

   .. oe:api::

      class OEMolBuilderOptions : public OESystem::OEOptions

   This class provides an interface to set up options required for generating
   an initial 3D structure of a molecule by connecting pregenerated fragment
   coordinates that constitute the molecule.

   .. seealso::

      * :ref:`OEMolBuilder <OEConfGen_OEMolBuilder>` class
      * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class

   The :ref:`OEMolBuilderOptions <OEConfGen_OEMolBuilderOptions>` class defines the following public methods:
    * :oe:meth:`GetCanonOrder<OEConfGen::OEMolBuilderOptions::GetCanonOrder>` and
      :oe:meth:`SetCanonOrder<OEConfGen::OEMolBuilderOptions::SetCanonOrder>`
    * :oe:meth:`GetEnumNitrogen<OEConfGen::OEMolBuilderOptions::GetEnumNitrogen>` and
      :oe:meth:`SetEnumNitrogen<OEConfGen::OEMolBuilderOptions::SetEnumNitrogen>`
    * :oe:meth:`GetEnumRing<OEConfGen::OEMolBuilderOptions::GetEnumRing>` and
      :oe:meth:`SetEnumRing<OEConfGen::OEMolBuilderOptions::SetEnumRing>`
    * :oe:meth:`SetFragBuilderMode<OEConfGen::OEMolBuilderOptions::SetFragBuilderMode>`
    * :oe:meth:`GetFragBuilderOptions<OEConfGen::OEMolBuilderOptions::GetFragBuilderOptions>` and
      :oe:meth:`SetFragBuilderOptions<OEConfGen::OEMolBuilderOptions::SetFragBuilderOptions>`
    * :oe:meth:`GetFromCT<OEConfGen::OEMolBuilderOptions::GetFromCT>` and
      :oe:meth:`SetFromCT<OEConfGen::OEMolBuilderOptions::SetFromCT>`
    * :oe:meth:`GetIgnoreStereo<OEConfGen::OEMolBuilderOptions::GetIgnoreStereo>` and
      :oe:meth:`SetIgnoreStereo<OEConfGen::OEMolBuilderOptions::SetIgnoreStereo>`
    * :oe:meth:`GetMaxEnumConfs<OEConfGen::OEMolBuilderOptions::GetMaxEnumConfs>` and
      :oe:meth:`SetMaxEnumConfs<OEConfGen::OEMolBuilderOptions::SetMaxEnumConfs>`
    * :oe:meth:`GetSampleHydrogens<OEConfGen::OEMolBuilderOptions::GetSampleHydrogens>` and
      :oe:meth:`SetSampleHydrogens<OEConfGen::OEMolBuilderOptions::SetSampleHydrogens>`
    * :oe:meth:`GetStrictAtomTypes<OEConfGen::OEMolBuilderOptions::GetStrictAtomTypes>` and
      :oe:meth:`SetStrictAtomTypes<OEConfGen::OEMolBuilderOptions::SetStrictAtomTypes>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMolBuilderOptions()
            OEMolBuilderOptions(const OEMolBuilderOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolBuilderOptions() -> OEMolBuilderOptions
            OEMolBuilderOptions(arg2: OEMolBuilderOptions) -> OEMolBuilderOptions

      Default and copy constructors.

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

      .. oe:api::

         OEMolBuilderOptions &operator=(const OEMolBuilderOptions &)

      Assignment operator.

   .. _OEConfGen_OEMolBuilderOptions_GetCanonOrder:



   .. oe:method:: GetCanonOrder


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

         .. oe:api::

            bool GetCanonOrder() const

      .. oe:language:: python

         .. oe:api:: python

            GetCanonOrder() -> bool

      See the :oe:meth:`SetCanonOrder<OEConfGen::OEMolBuilderOptions::SetCanonOrder>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetEnumNitrogen:



   .. oe:method:: GetEnumNitrogen


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

         .. oe:api::

            unsigned int GetEnumNitrogen() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumNitrogen() -> int

      See the :oe:meth:`SetEnumNitrogen<OEConfGen::OEMolBuilderOptions::SetEnumNitrogen>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetEnumRing:



   .. oe:method:: GetEnumRing


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

         .. oe:api::

            bool GetEnumRing() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumRing() -> bool

      See the :oe:meth:`SetEnumRing<OEConfGen::OEMolBuilderOptions::SetEnumRing>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetFragBuilderOptions:



   .. oe:method:: GetFragBuilderOptions


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

         .. oe:api::

            OEFragBuilderOptions& GetFragBuilderOptions()
            const OEFragBuilderOptions& GetFragBuilderOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragBuilderOptions() -> OEFragBuilderOptions

      See the :oe:meth:`SetFragBuilderOptions<OEConfGen::OEMolBuilderOptions::SetFragBuilderOptions>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetFromCT:


   .. oe:method:: GetFromCT


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

         .. oe:api::

            bool GetFromCT() const

      .. oe:language:: python

         .. oe:api:: python

            GetFromCT() -> bool

      See the :oe:meth:`SetFromCT<OEConfGen::OEMolBuilderOptions::SetFromCT>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetIgnoreStereo:


   .. oe:method:: GetIgnoreStereo


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

         .. oe:api::

            bool GetIgnoreStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreStereo() -> bool

      See the :oe:meth:`SetIgnoreStereo<OEConfGen::OEMolBuilderOptions::SetIgnoreStereo>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetMaxEnumConfs:


   .. oe:method:: GetMaxEnumConfs


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

         .. oe:api::

            unsigned GetMaxEnumConfs() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxEnumConfs() -> int

      See the :oe:meth:`SetMaxEnumConfs<OEConfGen::OEMolBuilderOptions::SetMaxEnumConfs>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetSampleHydrogens:



   .. oe:method:: GetSampleHydrogens


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

         .. oe:api::

            bool GetSampleHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetSampleHydrogens() -> bool

      See the :oe:meth:`SetSampleHydrogens<OEConfGen::OEMolBuilderOptions::SetSampleHydrogens>` method.

   .. _OEConfGen_OEMolBuilderOptions_GetStrictAtomTypes:



   .. oe:method:: GetStrictAtomTypes


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

         .. oe:api::

            bool GetStrictAtomTypes() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictAtomTypes() -> bool

      See the :oe:meth:`SetStrictAtomTypes<OEConfGen::OEMolBuilderOptions::SetStrictAtomTypes>` method.

   .. _OEConfGen_OEMolBuilderOptions_SetCanonOrder:



   .. oe:method:: SetCanonOrder


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

         .. oe:api::

            bool SetCanonOrder(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetCanonOrder(value: bool) -> bool

      This method can be used to enable/disable the
      automatic reordering of input molecules to a canonical atom and bond
      order.  In order to obtain consistent results from different file
      formats and different connection table orders, **OMEGA** reorders the
      input connection table.
      If *true*, the atoms of the molecule are indexed in canonical order before
      building the molecule structure.
      Default: True

   .. _OEConfGen_OEMolBuilderOptions_SetEnumNitrogen:



   .. oe:method:: SetEnumNitrogen


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

         .. oe:api::

            bool SetEnumNitrogen(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumNitrogen(value: int) -> bool

      Sets whether the generated initial conformation should be **enumerated for invertible nitrogens**.
      Default: :oe:const:`OEConfGen::OENitrogenEnumeration::Unspecified`

      .. seealso::

         * :oe:constns:`OEConfGen::OENitrogenEnumeration` namespace

   .. _OEConfGen_OEMolBuilderOptions_SetEnumRing:



   .. oe:method:: SetEnumRing


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

         .. oe:api::

            bool SetEnumRing(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumRing(value: bool) -> bool

      Sets whether the generated initial conformation should be **enumerated for ring stereo**. If *true*, the
      builder will enumerate
      alternate ring conformations and generate multiple conformations, if available.
      Default: True


      .. _OEConfGen_OEMolBuilderOptions_SetFragBuilderMode:



   .. oe:method:: SetFragBuilderMode


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

         .. oe:api::

            bool SetFragBuilderMode(const unsigned mode)

      .. oe:language:: python

         .. oe:api:: python

            SetFragBuilderMode(mode: int) -> bool

      Sets the :oe:cls:`OEFragBuilderOptions<OEConfGen::OEFragBuilderOptions>` parameter defaults corresponding to the specified ``mode``.

   .. _OEConfGen_OEMolBuilderOptions_SetFragBuilderOptions:



   .. oe:method:: SetFragBuilderOptions


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

         .. oe:api::

            void SetFragBuilderOptions(const OEFragBuilderOptions&)

      .. oe:language:: python

         .. oe:api:: python

            SetFragBuilderOptions(opts: OEFragBuilderOptions) -> None

      Sets :oe:cls:`OEFragBuilderOptions<OEConfGen::OEFragBuilderOptions>` related to building fragment coordinates.

      .. seealso::

         * :ref:`OEFragBuilderOptions <OEConfGen_OEFragBuilderOptions>` class

   .. _OEConfGen_OEMolBuilderOptions_SetFromCT:



   .. oe:method:: SetFromCT


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

         .. oe:api::

            bool SetFromCT(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetFromCT(value: bool) -> bool

      Sets whether the initial 3D coordinates should be generated from the
      **connection table of the input molecule**. If *true*, the initial 3D coordinates are
      generated from the connection table.
      Default: True

   .. _OEConfGen_OEMolBuilderOptions_SetIgnoreStereo:


   .. oe:method:: SetIgnoreStereo


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

         .. oe:api::

            bool SetIgnoreStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreStereo(value: bool) -> bool

      Sets whether **conformer generation should continue** even when specified stereo 
      signatures in a molecule could not be honored.
      Default: False

   .. _OEConfGen_OEMolBuilderOptions_SetMaxEnumConfs:



   .. oe:method:: SetMaxEnumConfs


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

         .. oe:api::

            bool SetMaxEnumConfs(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxEnumConfs(value: int) -> bool

      Sets the **maximum number of conformers** to be generated
      during enumeration.
      Default: 1024

   ..   _OEConfGen_SetSampleHydrogens:

   .. oe:method:: SetSampleHydrogens

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

         .. oe:api::

            bool SetSampleHydrogens(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetSampleHydrogens(value: bool) -> bool

      Sets whether **hydrogen sampling** should be performed on
      generated structures. If *true*, hydrogen sampling is performed.
      Default: False

   .. _OEConfGen_OEMolBuilderOptions_SetStrictAtomTypes:



   .. oe:method:: SetStrictAtomTypes


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

         .. oe:api::

            bool SetStrictAtomTypes(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictAtomTypes(value: bool) -> bool

      Sets whether **strict definition of atom typing** should be used.
      If *true*, a molecule will fail if any atom does not have a valid atom type.
      Calling this method with *false* will allow the atom typer to look for a
      different atom type of the same element and replace the failing
      atom type with a valid one that is "close enough."
      Default: True
