.. oe:namespace:: OEChem


.. _OEChem_OEConfRMSDOptions:

.. oe:class:: OEConfRMSDOptions

   .. oe:api::

      class OEConfRMSDOptions : public OESystem::OEOptions

   This class represents options for setting up :oe:func:`OEChem::OEConfRMSD`
   calculations.

   .. seealso::

      * :ref:`OEConfRMSD <OEChem_OEConfRMSD>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEConfRMSDOptions()
            OEConfRMSDOptions(const OEConfRMSDOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEConfRMSDOptions() -> OEConfRMSDOptions
            OEConfRMSDOptions(arg2: OEConfRMSDOptions) -> OEConfRMSDOptions

      Default and copy constructors.

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

      .. oe:api::

         OEConfRMSDOptions &operator=(const OEConfRMSDOptions &)

      Assignment operator.

   .. oe:method:: GetIgnoreHydrogens

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

         .. oe:api::

            bool GetIgnoreHydrogens() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreHydrogens() -> bool

      If ``true``, hydrogen atoms are ignored when assessing automorphisms.

   .. oe:method:: GetIgnoreTerminalHeavy

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

         .. oe:api::

            bool GetIgnoreTerminalHeavy() const

      .. oe:language:: python

         .. oe:api:: python

            GetIgnoreTerminalHeavy() -> bool

      If ``true``, terminal heavy atoms are ignored when assessing automorphisms.

   .. oe:method:: GetMaxMatches

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

         .. oe:api::

            unsigned int GetMaxMatches() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMatches() -> int

      Returns the maximum number of automorphism solutions that the
      :ref:`OESubSearch <OEChem_OESubSearch>` object will identify before
      terminating the search.

   .. oe:method:: SetIgnoreHydrogens

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

         .. oe:api::

            bool SetIgnoreHydrogens(bool ignore)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreHydrogens(value: bool) -> bool

      Sets whether to ignore or consider hydrogen atoms when assessing
      automorphisms in the molecule graph. The default is ``true``.
      Hydrogen atom can not be considered while ignoring terminal heavy atoms.

   .. oe:method:: SetIgnoreTerminalHeavy

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

         .. oe:api::

            bool SetIgnoreTerminalHeavy(bool ignore)

      .. oe:language:: python

         .. oe:api:: python

            SetIgnoreTerminalHeavy(value: bool) -> bool

      Sets whether to ignore or consider terminal heavy atoms assessing automorphisms
      in the molecule graphs. The default is ``false``.
      Terminal heavy atoms can not be ignored while considering hydrogens.

   .. oe:method:: SetMaxMatches

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

         .. oe:api::

            bool SetMaxMatches(unsigned int maxmatches)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMatches(value: int) -> bool

      Sets the maximum number of subgraphs to be determined by the
      :oe:meth:`OEChem::OESubSearch::Match` method.  Once the maximum number of
      subgraphs have been found, the search for additional subgraphs is
      terminated.  By default, the maximum number of matches is set to ``16384``. The
      method returns ``false`` if the maximum number of matches is zero.
