.. oe:namespace:: OEChem


.. _OEChem_OE2DRingDictionaryCreatorOptions:

.. oe:class:: OE2DRingDictionaryCreatorOptions

   .. oe:api::

      class OE2DRingDictionaryCreatorOptions

   This class represents the :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` class
   that encapsulates properties that determine how a ring template is added to
   a ring template dictionary (:ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>`).

   .. seealso::

      * :ref:`chapter_2D_coordinates` chapter
      * :ref:`OE2DRingDictionary <OEChem_OE2DRingDictionary>` class
      * :oe:func:`OEChem::OEWrite2DRingDictionary` function

   .. ################################################################
      # Constructors
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OE2DRingDictionaryCreatorOptions()

      .. oe:language:: python

         .. oe:api:: python

            OE2DRingDictionaryCreatorOptions() -> OE2DRingDictionaryCreatorOptions

      Default constructor.

      An :ref:`OE2DRingDictionaryCreatorOptions <OEChem_OE2DRingDictionaryCreatorOptions>` object is initialized
      with the following default parameters:

      * A ring system will be added to the dictionary even if a corresponding
        layout already exists in the built-in ring dictionary *i.e.* user-defined
        layout will have higher priority.

        See also :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetRetainExistingBuiltInTemplates`
        method.

      * If a ring system already exists in the given dictionary then the new
        ring template will be ignored *i.e* first-come first-register.

        See also :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetRetainExistingTemplates`
        method.

      * If a ring system has specified cis/trans bond stereo configuration then
        two layouts could be added to the ring dictionary: one with the cis/trans
        bond stereo configuration and one pure carbon skeleton without
        any bond stereo configuration.

        See also :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetAddCarbonSkeleton`
        and :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetAddCarbonSkeletonWithBondStereo`
        methods.


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

         .. oe:api::

            OE2DRingDictionaryCreatorOptions(const OE2DRingDictionaryCreatorOptions& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OE2DRingDictionaryCreatorOptions(rhs: OE2DRingDictionaryCreatorOptions) -> OE2DRingDictionaryCreatorOptions

      Copy constructor.

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

      .. oe:api::

         OE2DRingDictionaryCreatorOptions &operator=(const OE2DRingDictionaryCreatorOptions &rhs)

      Assignment operator.

   .. oe:method:: GetAddCarbonSkeleton

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

         .. oe:api::

            bool GetAddCarbonSkeleton() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCarbonSkeleton() -> bool

      Returns whether the carbon skeleton of a ring system is added to 
      the dictionary.
      The default value is ``true``.

      .. seealso::

         * :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetAddCarbonSkeleton` method


   .. oe:method:: GetAddCarbonSkeletonWithBondStereo

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

         .. oe:api::

            bool GetAddCarbonSkeletonWithBondStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddCarbonSkeletonWithBondStereo() -> bool

      Returns whether the carbon skeleton of a ring system retaining 
      cis/trans bond stereo configuration is added to the dictionary.
      The default value is ``true``.

      .. seealso::

         * :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetAddCarbonSkeletonWithBondStereo` method


   .. oe:method:: GetRetainExistingBuiltInTemplates

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

         .. oe:api::

            bool GetRetainExistingBuiltInTemplates() const

      .. oe:language:: python

         .. oe:api:: python

            GetRetainExistingBuiltInTemplates() -> bool

      Sets whether a ring system will be added to the dictionary
      even if a corresponding layout already exists in the built-in ring
      dictionary.

      .. seealso::

         * :oe:meth:`OEChem::OE2DRingDictionaryCreatorOptions::SetRetainExistingBuiltInTemplates` 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 override the ring template that already
      exists in the dictionary.

      .. seealso::

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


   .. oe:method:: SetAddCarbonSkeleton

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

         .. oe:api::

            void SetAddCarbonSkeleton(bool add)

      .. oe:language:: python

         .. oe:api:: python

            SetAddCarbonSkeleton(arg2: bool) -> None

      Sets whether the carbon skeleton of a ring system is added
      to the dictionary.

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

         **Example of extracting the carbon skeleton of a ring system**


   .. oe:method:: SetAddCarbonSkeletonWithBondStereo

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

         .. oe:api::

            void SetAddCarbonSkeletonWithBondStereo(bool add)

      .. oe:language:: python

         .. oe:api:: python

            SetAddCarbonSkeletonWithBondStereo(arg2: bool) -> None

      Sets whether the carbon skeleton of a ring system retaining 
      cis/trans bond stereo configuration is added to the dictionary.
      The default value is ``true``.

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

         **Example of extracting the carbon skeleton of a ring system with
         cis/trans bond stereo configuration**


   .. oe:method:: SetRetainExistingBuiltInTemplates

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

         .. oe:api::

            void SetRetainExistingBuiltInTemplates(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRetainExistingBuiltInTemplates(arg2: bool) -> None

      Sets whether a ring system will be added to the dictionary
      even if a corresponding layout already exists in the built-in ring
      dictionary.
      The default value is ``false`` i.e. user-defined ring layouts will
      have higher priority than the built-in ring templates.


   .. oe:method:: SetRetainExistingTemplates

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

         .. oe:api::

            void SetRetainExistingTemplates(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetRetainExistingTemplates(arg2: bool) -> None

      Sets whether to override the ring template that already
      exists in the dictionary.
      The default value is ``false`` i.e. the new user-defined
      ring template will be ignored.
