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

.. oe:namespace:: OESaiph


.. meta::
   :keywords: OERecordToCSVOptions, RecordToCSVOptions


.. _OESaiph_OERecordToCSVOptions:


.. oe:class:: OERecordToCSVOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OERecordToCSVOptions

   Stores the delimiter, the order of the :ref:`OEFields <OEDataFlow_OEField>`, and
   whether a molecule title field is included for the :ref:`OERecordToCSV <OESaiph_OERecordToCSV>`.
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OERecordToCSVOptions()
            OERecordToCSVOptions(OERecordToCSVOptions &&)
            OERecordToCSVOptions(const OERecordToCSVOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OERecordToCSVOptions() -> OERecordToCSVOptions
            OERecordToCSVOptions(arg2: OERecordToCSVOptions) -> OERecordToCSVOptions

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

      .. oe:api::

         OERecordToCSVOptions &operator=(const OERecordToCSVOptions &)

      Assignment operator.


   .. oe:method:: GetDelimiter

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

         .. oe:api::

            char GetDelimiter() const

      .. oe:language:: python

         .. oe:api:: python

            GetDelimiter() -> str

      Returns the delimiter set for the CSV file.

   .. oe:method:: GetIncludeMolTitle

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

         .. oe:api::

            bool GetIncludeMolTitle() const

      .. oe:language:: python

         .. oe:api:: python

            GetIncludeMolTitle() -> bool

      Returns a boolean based on whether a molecule title field will be added.

   .. oe:method:: GetOrderedFields

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

         .. oe:api::

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

      .. oe:language:: python

         .. oe:api:: python

            GetOrderedFields() -> OEStringVector

      Returns a vector of strings for how the :ref:`OEField <OEDataFlow_OEField>` are ordered.

   .. oe:method:: SetDelimiter

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

         .. oe:api::

            void SetDelimiter(char delimiter)

      .. oe:language:: python

         .. oe:api:: python

            SetDelimiter(delimiter: str) -> None

      Sets the delimiter for the CSV file.

   .. oe:method:: SetIncludeMolTitle

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

         .. oe:api::

            void SetIncludeMolTitle(bool state)

      .. oe:language:: python

         .. oe:api:: python

            SetIncludeMolTitle(state: bool) -> None

      Boolean for adding a Mol Title :ref:`OEField <OEDataFlow_OEField>` to the CSV.

   .. oe:method:: SetOrderedFields

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

         .. oe:api::

            void SetOrderedFields(const std::vector<std::string>& orderedFields)

      .. oe:language:: python

         .. oe:api:: python

            SetOrderedFields(orderedFields: OEStringVector) -> None

      Sets the :ref:`OEField <OEDataFlow_OEField>` order of the CSV file.

