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

.. oe:namespace:: OEConfGen


.. meta::
   :keywords: OEFlipperClassicOptions, OmegaOptions

.. _OEConfGen_OEFlipperClassicOptions:

.. oe:class:: OEFlipperClassicOptions

   .. oe:api::

      class OEFlipperClassicOptions : public OEFlipperOptions

   .. caution::

     |DEPRECATED-API|

     This class was introduced to allow validation of previous **Flipper** results against the preferred
     updated flag options. It will be removed in a subsequent release.

   .. seealso::

      * :ref:`OEFlipperOptions <OEConfGen_OEFlipperOptions>` class
      * :ref:`OEFlipper <OEConfGen_OEFlipper>` function

   The :ref:`OEFlipperClassicOptions <OEConfGen_OEFlipperClassicOptions>` class defines the following public methods:
    * :oe:meth:`GetAtomPredicate<OEConfGen::OEFlipperClassicOptions::GetAtomPredicate>` and
      :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperClassicOptions::SetAtomPredicate>`
    * :oe:meth:`GetBondPredicate<OEConfGen::OEFlipperClassicOptions::GetBondPredicate>` and
      :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperClassicOptions::SetBondPredicate>`
    * :oe:meth:`GetEnhancedStereo<OEConfGen::OEFlipperClassicOptions::GetEnhancedStereo>` and
      :oe:meth:`SetEnhancedStereo<OEConfGen::OEFlipperClassicOptions::SetEnhancedStereo>`
    * :oe:meth:`GetEnumBridgehead<OEConfGen::OEFlipperClassicOptions::GetEnumBridgehead>` and
      :oe:meth:`SetEnumBridgehead<OEConfGen::OEFlipperClassicOptions::SetEnumBridgehead>`
    * :oe:meth:`GetEnumEZ<OEConfGen::OEFlipperClassicOptions::GetEnumEZ>` and
      :oe:meth:`SetEnumEZ<OEConfGen::OEFlipperClassicOptions::SetEnumEZ>`
    * :oe:meth:`GetEnumNitrogen<OEConfGen::OEFlipperClassicOptions::GetEnumNitrogen>` and
      :oe:meth:`SetEnumNitrogen<OEConfGen::OEFlipperClassicOptions::SetEnumNitrogen>`
    * :oe:meth:`GetEnumRS<OEConfGen::OEFlipperClassicOptions::GetEnumRS>` and
      :oe:meth:`SetEnumRS<OEConfGen::OEFlipperClassicOptions::SetEnumRS>`
    * :oe:meth:`GetEnumSpecifiedStereo<OEConfGen::OEFlipperClassicOptions::GetEnumSpecifiedStereo>` and
      :oe:meth:`SetEnumSpecifiedStereo<OEConfGen::OEFlipperClassicOptions::SetEnumSpecifiedStereo>`
    * :oe:meth:`GetMaxCenters<OEConfGen::OEFlipperClassicOptions::GetMaxCenters>` and
      :oe:meth:`SetMaxCenters<OEConfGen::OEFlipperClassicOptions::SetMaxCenters>`
    * :oe:meth:`GetWarts<OEConfGen::OEFlipperClassicOptions::GetWarts>` and
      :oe:meth:`SetWarts<OEConfGen::OEFlipperClassicOptions::SetWarts>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEFlipperClassicOptions()
            OEFlipperClassicOptions(const OEFlipperClassicOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEFlipperClassicOptions() -> OEFlipperClassicOptions
            OEFlipperClassicOptions(arg2: OEFlipperClassicOptions) -> OEFlipperClassicOptions

      Default and copy constructors.

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

      .. oe:api::

         OEFlipperClassicOptions &operator=(const OEFlipperClassicOptions &)

      Assignment operator.

   .. oe:method:: GetAtomPredicate

      .. oe:api::

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

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

   .. oe:method:: GetBondPredicate

      .. oe:api::

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

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

   .. oe:method:: GetEnhancedStereo

      .. oe:api::

         bool GetEnhancedStereo() const

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

   .. oe:method:: GetEnumBridgehead

      .. oe:api::

         bool GetEnumBridgehead() const

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

   .. oe:method:: GetEnumEZ

      .. oe:api::

         bool GetEnumEZ() const

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

   .. oe:method:: GetEnumNitrogen

      .. oe:api::

         bool GetEnumNitrogen() const

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

   .. oe:method:: GetEnumRS

      .. oe:api::

         bool GetEnumRS() const

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

   .. oe:method:: GetEnumSpecifiedStereo

      .. oe:api::

         bool GetEnumSpecifiedStereo() const

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

   .. oe:method:: GetMaxCenters

      .. oe:api::

         unsigned GetMaxCenters() const

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

   .. oe:method:: GetWarts

      .. oe:api::

         bool GetWarts() const

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

   .. oe:method:: SetAtomPredicate

      .. oe:api::

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

      Provides an input atom predicate to define the selection of the atom stereocenters which should be enumerated.
      For explicit user predicates, the bond predicate must also be provided explicitly.
      See the :oe:meth:`SetBondPredicate<OEConfGen::OEFlipperClassicOptions::SetBondPredicate>` method.


   .. oe:method:: SetBondPredicate

      .. oe:api::

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

      Provides an input bond predicate to define the selection of the bond stereocenters which should be enumerated.
      For explicit user predicates, the atom predicate must also be provided explicitly.
      See the :oe:meth:`SetAtomPredicate<OEConfGen::OEFlipperClassicOptions::SetAtomPredicate>` method.

   .. oe:method:: SetEnhancedStereo

      .. oe:api::

         bool SetEnhancedStereo(const bool)

      Sets whether to consider explicit MDL enhanced stereogroups during flipping or not.
      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.
      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

   .. oe:method:: SetEnumBridgehead

      .. oe:api::

         bool SetEnumBridgehead(const bool)

      Sets whether to enumerate bridgehead stereocenters or not.
      Default: False

   .. oe:method:: SetEnumEZ

      .. oe:api::

         bool SetEnumEZ(const bool)

      Sets whether to enumerate *only* E/Z stereocenters or not. If *true*, no atoms are enumerated.
      Default: False

   .. oe:method:: SetEnumNitrogen

      .. oe:api::

         bool SetEnumNitrogen(const bool)

      Controls the behavior with respect to 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

   .. oe:method:: SetEnumRS

      .. oe:api::

         bool SetEnumRS(const bool)

      Sets whether to enumerate *only* R/S stereocenters or not. If *true*, no bonds are enumerated.
      Default: False

   .. oe:method:: SetEnumSpecifiedStereo

      .. oe:api::

         bool SetEnumSpecifiedStereo(const bool)

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

   .. oe:method:: SetMaxCenters

      .. oe:api::

         bool SetMaxCenters(const unsigned)

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

   .. oe:method:: SetWarts

      .. oe:api::

         bool SetWarts(const bool)

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