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

.. oe:namespace:: OEChem

.. oe:class:: OEHelmGenerationOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEHelmGenerationOptions

   Encapsulates the properties that control HELM generation from a molecule.

   .. seealso::

      * :oe:cls:`OEChem::OEHelmGenerationResult` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEHelmGenerationOptions()
            OEHelmGenerationOptions(const std::string& codeSet,
                                    bool allowUnspecifiedStereo = false,
                                    bool allowPartialMonomerMatch = false)

      .. oe:language:: python

         .. oe:api:: python

            OEHelmGenerationOptions() -> OEHelmGenerationOptions
            OEHelmGenerationOptions(codeSet: str,
                                    allowUnspecifiedStereo: bool = False,
                                    allowPartialMonomerMatch: bool = False) -> OEHelmGenerationOptions

      Default constructor.

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

         .. oe:api::

            OEHelmGenerationOptions(const OEHelmGenerationOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEHelmGenerationOptions(arg2: OEHelmGenerationOptions) -> OEHelmGenerationOptions

      Copy constructor.

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

      .. oe:api::

         OEHelmGenerationOptions &operator=(const OEHelmGenerationOptions &)

      Assignment operator.

   .. oe:method:: GetAllowUnmatchedFragments

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

         .. oe:api::

            bool GetAllowUnmatchedFragments() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowUnmatchedFragments() -> bool

      Returns whether unmatched fragments are allowed when generating the :term:`HELM`
      when using :oe:func:`OEChem::OEMolToHelm` function.
      Unmatched fragments  will be encoded as embedded SMILES in the generated  :term:`HELM`
      string.

   .. oe:method:: GetAllowUnspecifiedStereo

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

         .. oe:api::

            bool GetAllowUnspecifiedStereo() const

      .. oe:language:: python

         .. oe:api:: python

            GetAllowUnspecifiedStereo() -> bool

      Returns whether unspecified atom or bond stereochemistry are allowed when 
      generating the :term:`HELM` when using :oe:func:`OEChem::OEMolToHelm` function.

   .. oe:method:: GetCodeSet

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

         .. oe:api::

            std::string GetCodeSet() const

      .. oe:language:: python

         .. oe:api:: python

            GetCodeSet() -> str

      Returns the code-set to be used for generating the :term:`HELM` string.

      .. seealso::

         * :oe:meth:`OEChem::OEHelmGenerationOptions::SetCodeSet` method

   .. oe:method:: GetMinUnmatchedAtomsRatio

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

         .. oe:api::

            double GetMinUnmatchedAtomsRatio() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinUnmatchedAtomsRatio() -> float

      Returns the minimum atom to fragment ratio that are allowed when generating the :term:`HELM`
      when using :oe:func:`OEChem::OEMolToHelm` function.

   .. oe:method:: SetAllowUnmatchedFragments

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

         .. oe:api::

            bool SetAllowUnmatchedFragments(bool allow)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowUnmatchedFragments(value: bool) -> bool

      Sets whether unmatched fragments are allowed when generating the :term:`HELM`
      when using :oe:func:`OEChem::OEMolToHelm` function.

   .. oe:method:: SetAllowUnspecifiedStereo

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

         .. oe:api::

            bool SetAllowUnspecifiedStereo(bool allow)

      .. oe:language:: python

         .. oe:api:: python

            SetAllowUnspecifiedStereo(value: bool) -> bool

      Sets whether unspecified atom or bond stereochemistry are allowed when 
      generating the :term:`HELM` when using :oe:func:`OEChem::OEMolToHelm` function.

   .. oe:method:: SetCodeSet

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

         .. oe:api::

            void SetCodeSet(const std::string& codeSet)

      .. oe:language:: python

         .. oe:api:: python

            SetCodeSet(value: str) -> bool

      Sets the code-set to be used for generating the :term:`HELM` string.
      If not set the primary code-set will be used. 

      .. seealso::

         * :oe:meth:`OEChem::OEMonomerSet::GetPrimaryCodeSet` method

   .. oe:method:: SetMinUnmatchedAtomsRatio

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

         .. oe:api::

            bool SetMinUnmatchedAtomsRatio(double minRatio)

      .. oe:language:: python

         .. oe:api:: python

            SetMinUnmatchedAtomsRatio(value: float) -> bool

      Sets the minimum atom to fragment ratio that are allowed when generating the :term:`HELM`
      when using :oe:func:`OEChem::OEMolToHelm` function.
