.. oe:namespace:: OEConfGen


.. meta::
   :keywords: OEFlipperOptions, OmegaOptions

.. _OEConfGen_OEFlipperOptions:

.. oe:class:: OEFlipperOptions

   .. oe:api::

      class OEFlipperOptions : public OESystem::OEOptions

   .. seealso::

      * :ref:`OEFlipper <OEConfGen_OEFlipper>` function

   .. admonition:: Code Examples

      * :ref:`section_examples_stereo_and_torsion` example

   The :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>` class defines the following public methods:
    * :oe:meth:`GetAtomPredicate<OEConfGen::OEFlipperOptions::GetAtomPredicate>` and
      :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperOptions::SetAtomPredicate>`
    * :oe:meth:`GetBondPredicate<OEConfGen::OEFlipperOptions::GetBondPredicate>` and
      :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperOptions::SetBondPredicate>`
    * :oe:meth:`GetEnhancedStereo<OEConfGen::OEFlipperOptions::GetEnhancedStereo>` and
      :oe:meth:`SetEnhancedStereo<OEConfGen::OEFlipperOptions::SetEnhancedStereo>`
    * :oe:meth:`GetEnumAtoms<OEConfGen::OEFlipperOptions::GetEnumAtoms>` and
      :oe:meth:`SetEnumAtoms<OEConfGen::OEFlipperOptions::SetEnumAtoms>`
    * :oe:meth:`GetEnumAtomSpecifiedStereo<OEConfGen::OEFlipperOptions::GetEnumAtomSpecifiedStereo>` and
      :oe:meth:`SetEnumAtomSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumAtomSpecifiedStereo>`
    * :oe:meth:`GetEnumBonds<OEConfGen::OEFlipperOptions::GetEnumBonds>` and
      :oe:meth:`SetEnumBonds<OEConfGen::OEFlipperOptions::SetEnumBonds>`
    * :oe:meth:`GetEnumBondSpecifiedStereo<OEConfGen::OEFlipperOptions::GetEnumBondSpecifiedStereo>` and
      :oe:meth:`SetEnumBondSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumBondSpecifiedStereo>`
    * :oe:meth:`GetEnumBridgehead<OEConfGen::OEFlipperOptions::GetEnumBridgehead>` and
      :oe:meth:`SetEnumBridgehead<OEConfGen::OEFlipperOptions::SetEnumBridgehead>`
    * :oe:meth:`GetEnumEZ<OEConfGen::OEFlipperOptions::GetEnumEZ>` and
      :oe:meth:`SetEnumEZ<OEConfGen::OEFlipperOptions::SetEnumEZ>`
    * :oe:meth:`GetEnumNitrogen<OEConfGen::OEFlipperOptions::GetEnumNitrogen>` and
      :oe:meth:`SetEnumNitrogen<OEConfGen::OEFlipperOptions::SetEnumNitrogen>`
    * :oe:meth:`GetEnumRS<OEConfGen::OEFlipperOptions::GetEnumRS>` and
      :oe:meth:`SetEnumRS<OEConfGen::OEFlipperOptions::SetEnumRS>`
    * :oe:meth:`GetEnumSpecifiedStereo<OEConfGen::OEFlipperOptions::GetEnumSpecifiedStereo>` and
      :oe:meth:`SetEnumSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumSpecifiedStereo>`
    * :oe:meth:`GetEnumRelativeAtomStereo<OEConfGen::OEFlipperOptions::GetEnumRelativeAtomStereo>` and
      :oe:meth:`SetEnumRelativeAtomStereo<OEConfGen::OEFlipperOptions::SetEnumRelativeAtomStereo>`
    * :oe:meth:`GetMaxCenters<OEConfGen::OEFlipperOptions::GetMaxCenters>` and
      :oe:meth:`SetMaxCenters<OEConfGen::OEFlipperOptions::SetMaxCenters>`
    * :oe:meth:`GetWarts<OEConfGen::OEFlipperOptions::GetWarts>` and
      :oe:meth:`SetWarts<OEConfGen::OEFlipperOptions::SetWarts>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEFlipperOptions()
            OEFlipperOptions(const OEFlipperOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEFlipperOptions() -> OEFlipperOptions
            OEFlipperOptions(arg2: OEFlipperOptions) -> OEFlipperOptions

      Default and copy constructors.

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

      .. oe:api::

         OEFlipperOptions &operator=(const OEFlipperOptions &)

      Assignment operator.

   .. _OEConfGen_OEFlipperOptions_GetAtomPredicate:

   .. oe:method:: GetAtomPredicate

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

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>* GetAtomPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomPredicate() -> OEUnaryAtomPred

      See the :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperOptions::SetAtomPredicate>` method.

   .. _OEConfGen_OEFlipperOptions_GetBondPredicate:

   .. oe:method:: GetBondPredicate

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

         .. oe:api::

            const OESystem::OEUnaryPredicate<OEChem::OEBondBase>* GetBondPredicate() const

      .. oe:language:: python

         .. oe:api:: python

            GetBondPredicate() -> OEUnaryBondPred

      See the :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperOptions::SetBondPredicate>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnhancedStereo:

   .. oe:method:: GetEnhancedStereo

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

         .. oe:api::

            bool GetEnhancedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnhancedStereo() -> bool

      See the :oe:meth:`SetEnhancedStereo<OEConfGen::OEFlipperOptions::SetEnhancedStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumAtoms:

   .. oe:method:: GetEnumAtoms

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

         .. oe:api::

            bool GetEnumAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumAtoms() -> bool

      See the :oe:meth:`SetEnumAtoms<OEConfGen::OEFlipperOptions::SetEnumAtoms>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumAtomSpecifiedStereo:

   .. oe:method:: GetEnumAtomSpecifiedStereo

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

         .. oe:api::

            bool GetEnumAtomSpecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumAtomSpecifiedStereo() -> bool

      See the :oe:meth:`SetEnumAtomSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumAtomSpecifiedStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumBonds:

   .. oe:method:: GetEnumBonds

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

         .. oe:api::

            bool GetEnumBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumBonds() -> bool

      See the :oe:meth:`SetEnumBonds<OEConfGen::OEFlipperOptions::SetEnumBonds>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumBondSpecifiedStereo:

   .. oe:method:: GetEnumBondSpecifiedStereo

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

         .. oe:api::

            bool GetEnumBondSpecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumBondSpecifiedStereo() -> bool

      See the :oe:meth:`SetEnumBondSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumBondSpecifiedStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumBridgehead:

   .. oe:method:: GetEnumBridgehead

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

         .. oe:api::

            bool GetEnumBridgehead() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumBridgehead() -> bool

      See the :oe:meth:`SetEnumBridgehead<OEConfGen::OEFlipperOptions::SetEnumBridgehead>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumEZ:

   .. oe:method:: GetEnumEZ

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

         .. oe:api::

            bool GetEnumEZ() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumEZ() -> bool

      See the :oe:meth:`SetEnumEZ<OEConfGen::OEFlipperOptions::SetEnumEZ>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumNitrogen:

   .. oe:method:: GetEnumNitrogen

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

         .. oe:api::

            bool GetEnumNitrogen() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumNitrogen() -> bool

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

   .. _OEConfGen_OEFlipperOptions_GetEnumRS:

   .. oe:method:: GetEnumRS

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

         .. oe:api::

            bool GetEnumRS() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumRS() -> bool

      See the :oe:meth:`SetEnumRS<OEConfGen::OEFlipperOptions::SetEnumRS>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumRelativeAtomStereo:

   .. oe:method:: GetEnumRelativeAtomStereo

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

         .. oe:api::

            bool GetEnumRelativeAtomStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumRelativeAtomStereo() -> bool

      See the :oe:meth:`SetEnumRelativeAtomStereo<OEConfGen::OEFlipperOptions::SetEnumRelativeAtomStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetEnumSpecifiedStereo:

   .. oe:method:: GetEnumSpecifiedStereo

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

         .. oe:api::

            bool GetEnumSpecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumSpecifiedStereo() -> bool

      See the :oe:meth:`SetEnumSpecifiedStereo<OEConfGen::OEFlipperOptions::SetEnumSpecifiedStereo>` method.

   .. _OEConfGen_OEFlipperOptions_GetMaxCenters:


   .. oe:method:: GetMaxCenters

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

         .. oe:api::

            unsigned GetMaxCenters() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxCenters() -> int

      See the :oe:meth:`SetMaxCenters<OEConfGen::OEFlipperOptions::SetMaxCenters>` method.

   .. _OEConfGen_OEFlipperOptions_GetWarts:

   .. oe:method:: GetWarts

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

         .. oe:api::

            bool GetWarts() const

      .. oe:language:: python

         .. oe:api:: python

            GetWarts() -> bool

      See the :oe:meth:`SetWarts<OEConfGen::OEFlipperOptions::SetWarts>` method.

   .. _OEConfGen_OEFlipperOptions_SetAtomPredicate:

   .. oe:method:: SetAtomPredicate

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

         .. oe:api::

            bool SetAtomPredicate(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>&)

      .. oe:language:: python

         .. oe:api:: python

            SetAtomPredicate(value: OEUnaryAtomPred) -> bool

      Provides an input atom predicate to define the selection of the atom stereocenters which should be enumerated.

   .. _OEConfGen_OEFlipperOptions_SetBondPredicate:

   .. oe:method:: SetBondPredicate

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

         .. oe:api::

            bool SetBondPredicate(const OESystem::OEUnaryPredicate<OEChem::OEBondBase>&)

      .. oe:language:: python

         .. oe:api:: python

            SetBondPredicate(value: OEUnaryBondPred) -> bool

      Provides an input bond predicate to define the selection of the bond stereocenters which should be enumerated.

   .. _OEConfGen_OEFlipperOptions_SetEnhancedStereo:

   .. oe:method:: SetEnhancedStereo

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

         .. oe:api::

            bool SetEnhancedStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnhancedStereo(value: bool) -> bool

      Sets whether to consider explicit MDL enhanced stereogroups during flipping.
      Enhanced stereogroups generally contain a collection of stereocenters which should be considered
      as a collective unit, where a "flip" implies that all centers in the group should be flipped,
      thus retaining the relative stereo parity between the grouped stereocenters.  With this flag enabled,
      far fewer enantiomers will be generated than for individual stereocenter flipping activities,
      and relative stereo configurations will be retained.  When enabled, explicitly marked absolute
      stereocenters are excluded from the flipping activities.  Care should be taken to ensure that any
      custom atom predicate returns all atoms involved in enhanced stereogroups.
      Default: False

      .. note::

         The membership and type of existing enhanced stereogroups are not modified as a result of the flipping operation.
         That is, the explicit stereogroups of ``and`` and ``or`` are not promoted to ``abs`` groups as a result of stereocenter parity flips.
         This retains the source of original stereogroup(s) in the generated isomer(s) for post-flipping validations and processing.
         This behavior is *true* regardless of the setting of :oe:meth:`GetEnhancedStereo<OEConfGen::OEFlipperOptions::GetEnhancedStereo>`.
         Stereocenters can be explicitly promoted to ``abs`` centers by deletion of all stereogroups, or by deleting all stereogroups and
         adding marked stereocenters to a single new ``abs`` stereogroup.

      .. seealso::

         * :oe:meth:`GetGroups<OEChem::OEMolBase::GetGroups>` method
         * :oe:cls:`OEIsMDLStereoGroup<OEChem::OEIsMDLStereoGroup>` class

   .. _OEConfGen_OEFlipperOptions_SetEnumAtoms:

   .. oe:method:: SetEnumAtoms

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

         .. oe:api::

            bool SetEnumAtoms(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumAtoms(value: bool) -> bool

      Sets whether to include R/S stereocenters in the enumeration or not. If *false*,
      disregards atom enumerations.
      Default: True

   .. _OEConfGen_OEFlipperOptions_SetEnumAtomSpecifiedStereo:

   .. oe:method:: SetEnumAtomSpecifiedStereo

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

         .. oe:api::

            bool SetEnumAtomSpecifiedStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumAtomSpecifiedStereo(value: bool) -> bool

      Sets whether to force the modification of all R/S stereocenters in a molecule. If *false*, it
      will only enumerate stereocenters which do not already have a specified stereochemistry.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumBonds:

   .. oe:method:: SetEnumBonds

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

         .. oe:api::

            bool SetEnumBonds(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumBonds(value: bool) -> bool

      Sets whether to include E/Z bonds in the enumeration. If *false*,
      disregards bond enumerations.
      Default: True

   .. _OEConfGen_OEFlipperOptions_SetEnumBondSpecifiedStereo:


   .. oe:method:: SetEnumBondSpecifiedStereo

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

         .. oe:api::

            bool SetEnumBondSpecifiedStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumBondSpecifiedStereo(value: bool) -> bool

      Sets whether to force the modification of all E/Z stereocenters in a molecule. If *false*, it
      will only enumerate bonds which do not already have a specified stereochemistry.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumBridgehead:

   .. oe:method:: SetEnumBridgehead

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

         .. oe:api::

            bool SetEnumBridgehead(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumBridgehead(value: bool) -> bool

      Sets whether to enumerate bridgehead stereocenters.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumEZ:

   .. oe:method:: SetEnumEZ

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

         .. oe:api::

            bool SetEnumEZ(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumEZ(value: bool) -> bool

      Sets whether to enumerate E/Z stereocenters.
      Default: True

   .. _OEConfGen_OEFlipperOptions_SetEnumNitrogen:

   .. oe:method:: SetEnumNitrogen

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

         .. oe:api::

            bool SetEnumNitrogen(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumNitrogen(value: bool) -> bool

      Controls the behavior with respect to the enumeration of nonterminal nitrogens. Any nitrogen with pyramidal geometry in the initial model of
      the input molecule, and having no more than two ring bonds, is considered to be *invertible*. This will enumerate all possible puckers if set to *true*.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumRS:

   .. oe:method:: SetEnumRS

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

         .. oe:api::

            bool SetEnumRS(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumRS(value: bool) -> bool

      Sets whether to enumerate R/S stereocenters.
      Default: True

   .. _OEConfGen_OEFlipperOptions_SetEnumRelativeAtomStereo:

   .. oe:method:: SetEnumRelativeAtomStereo

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

         .. oe:api::

            bool SetEnumRelativeAtomStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumRelativeAtomStereo(value: bool) -> bool

      Sets whether to include enumeration of internally perceived relative atom stereocenters (e.g., 1,4-disubstituted cyclohexanes) in a molecule.
      If *true*, consider relative stereocenters during stereo enumeration.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetEnumSpecifiedStereo:

   .. oe:method:: SetEnumSpecifiedStereo

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

         .. oe:api::

            bool SetEnumSpecifiedStereo(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumSpecifiedStereo(value: bool) -> bool

      Sets whether to force the modification of all of the atom and bond stereocenters in a molecule. If *false*, it
      will only enumerate stereocenters which do not already have a specified stereochemistry.
      Default: False

   .. _OEConfGen_OEFlipperOptions_SetMaxCenters:

   .. oe:method:: SetMaxCenters

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

         .. oe:api::

            bool SetMaxCenters(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxCenters(value: int) -> bool

      Sets the maximum number of stereocenters or groups of stereocenters which will be fully enumerated.
      Default: 12

   .. _OEConfGen_OEFlipperOptions_SetWarts:

   .. oe:method:: SetWarts

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

         .. oe:api::

            bool SetWarts(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetWarts(value: bool) -> bool

      Sets whether to generate unique titles for molecules.
      Default: False
