.. oe:namespace:: OEChem


.. meta::
   :keywords: OEExtractRingTemplateOptions, ExtractRingTemplateOptions


.. _OEChem_OEExtractRingTemplateOptions:

.. oe:class:: OEExtractRingTemplateOptions

   .. oe:api::

      class OEExtractRingTemplateOptions

   This class represents :ref:`OEExtractRingTemplateOptions <OEChem_OEExtractRingTemplateOptions>` that
   stores the parameters that are used when extracting ring templates
   using :oe:func:`OEChem::OEExtractRingTemplates` function

   .. note::

      We recommend using the :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class for
      generating a ring template dictionary.

    .. figure:: ../images/OEExtractRingTemplates_Default.*
       :align: center

       **Example of extracting ring templates with default parameters**

   .. seealso::

      * :oe:func:`OEChem::OEExtractRingTemplates` function

   .. oe:method:: Constructors

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

         .. oe:api::

            OEExtractRingTemplateOptions()

      .. oe:language:: python

         .. oe:api:: python

            OEExtractRingTemplateOptions() -> OEExtractRingTemplateOptions

      Default constructor.

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

         .. oe:api::

            OEExtractRingTemplateOptions(const OEExtractRingTemplateOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEExtractRingTemplateOptions(rhs: OEExtractRingTemplateOptions) -> OEExtractRingTemplateOptions

      Copy constructor.

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

      .. oe:api::

         OEExtractRingTemplateOptions &operator=(const OEExtractRingTemplateOptions &rhs)
         Assignment operator.

   .. oe:method:: GetRetainBondStereo

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

         .. oe:api::

            bool GetRetainBondStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetRetainBondStereo() -> bool

      Returns whether the cis/trans bond stereo configurations are kept in macro-cycles
      when extracting ring systems.

      .. seealso::

        * :oe:meth:`OEChem::OEExtractRingTemplateOptions::SetRetainBondStereo` method

   .. oe:method:: GetRetainExistingTemplates

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

         .. oe:api::

            bool GetRetainExistingTemplates() const

      .. oe:language:: python

         .. oe:api:: python

            GetRetainExistingTemplates() -> bool

      Returns whether to return or ignore ring templates that have been already
      exist in the 2D coordinate generation system of OEChem.

      .. seealso::

        * :oe:meth:`OEChem::OEExtractRingTemplateOptions::SetRetainExistingTemplates` method

   .. oe:method:: SetRetainBondStereo

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

         .. oe:api::

            void SetRetainBondStereo(bool retain)

      .. oe:language:: python

         .. oe:api:: python

            SetRetainBondStereo(arg2: bool) -> None

      Sets whether the cis/trans bond stereo configurations are kept in macro-cycles
      when extracting ring systems.
      By default, the bond stereo configurations in macro-cycles are retained.

      .. figure:: ../images/OEExtractRingTemplates_RemoveBondStereo.*
         :align: center

         **Example of extracting ring templates with removing bond stereo configurations**

      .. seealso::

        * :oe:meth:`OEChem::OEExtractRingTemplateOptions::GetRetainBondStereo` method

   .. oe:method:: SetRetainExistingTemplates

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

         .. oe:api::

            void SetRetainExistingTemplates(bool retain)

      .. oe:language:: python

         .. oe:api:: python

            SetRetainExistingTemplates(arg2: bool) -> None

      Sets whether to return or ignore ring templates that have been already
      exist in the 2D coordinate generation system of OEChem.
      By default, the existing ring templates are ignored.

      .. figure:: ../images/OEExtractRingTemplates_RetainExistingTemplates.*
         :align: center

         **Example of extracting ring templates with keeping existing ring templates**

      .. seealso::

        * :oe:meth:`OEChem::OEExtractRingTemplateOptions::GetRetainExistingTemplates` method
