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

.. oe:namespace:: OESaiph


.. meta::
   :keywords: OEMolConversionOptions, MolConversionOptions


.. _OESaiph_OEMolConversionOptions:

.. oe:class:: OEMolConversionOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEMolConversionOptions : public OEConversionOptionsBase

   Gives many factors to customize ETL for the :ref:`OEMolFileConverter <OESaiph_OEMolFileConverter>`. SD data
   can be cleared, conformer tests can be turned on, custom generic data can be extracted, and custom Mol Title
   fields are options provided by :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`.
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEMolConversionOptions()
            OEMolConversionOptions(OEMolConversionOptions &&)
            OEMolConversionOptions(const OEMolConversionOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEMolConversionOptions() -> OEMolConversionOptions
            OEMolConversionOptions(arg2: OEMolConversionOptions) -> OEMolConversionOptions

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

      .. oe:api::

         OEMolConversionOptions &operator=(OEMolConversionOptions &&)
         OEMolConversionOptions &operator=(const OEMolConversionOptions &)

      Default constructor that initializes :ref:`OEMolConversionOptions <OESaiph_OEMolConversionOptions>`,
      where clearing SD data is set to false and setting conformer tests is set to false.

      Assignment operator.


   .. oe:method:: GetClearMolData

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

         .. oe:api::

            bool GetClearMolData() const

      .. oe:language:: python

         .. oe:api:: python

            GetClearMolData() -> bool

      Returns a boolean depending on whether the SD data of the :ref:`OERecord <OEDataFlow_OERecord>` will be cleared.

   .. oe:method:: GetConfTest

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

         .. oe:api::

            bool GetConfTest() const

      .. oe:language:: python

         .. oe:api:: python

            GetConfTest() -> bool

      Returns a boolean depending on whether the conformer tests are set during extraction.

   .. oe:method:: GetGenericDataTags

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

         .. oe:api::

            std::vector<std::string> GetGenericDataTags() const

      .. oe:language:: python

         .. oe:api:: python

            GetGenericDataTags() -> OEStringVector

      Returns a vector of a string of the generic data tags specified to be extracted from the file.

   .. oe:method:: GetMolTitleField

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

         .. oe:api::

            std::string GetMolTitleField() const

      .. oe:language:: python

         .. oe:api:: python

            GetMolTitleField() -> str

      Returns a string of the :ref:`OEField <OEDataFlow_OEField>` name for the Mol Title 
      :ref:`OEField <OEDataFlow_OEField>` that will be added. Only adds an :ref:`OEField <OEDataFlow_OEField>`
      if not left blank. 

   .. oe:method:: HasGenericDataTags

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

         .. oe:api::

            bool HasGenericDataTags() const

      .. oe:language:: python

         .. oe:api:: python

            HasGenericDataTags() -> bool

      Returns a boolean depending on whether any generic data tags are set.

   .. oe:method:: SetClearMolData

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

         .. oe:api::

            void SetClearMolData(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetClearMolData(state: bool) -> None

      Boolean for clearing the SD data of the file.

   .. oe:method:: SetConfTest

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

         .. oe:api::

            void SetConfTest(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetConfTest(state: bool) -> None

      Boolean for turning on conformer tests upon loading the file.

   .. oe:method:: SetGenericDataTags

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

         .. oe:api::

            void SetGenericDataTags(const std::vector<std::string>& tags)

      .. oe:language:: python

         .. oe:api:: python

            SetGenericDataTags(tags: OEStringVector) -> None

      Sets the generic data tags extracted from the file.

   .. oe:method:: SetMolTitleField

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

         .. oe:api::

            void SetMolTitleField(const std::string fieldName)

      .. oe:language:: python

         .. oe:api:: python

            SetMolTitleField(fieldName: str) -> None

      Sets the name of the Mol Title :ref:`OEField <OEDataFlow_OEField>`. This
      :ref:`OEField <OEDataFlow_OEField>` is only added if the fieldName is not blank.

