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

.. oe:namespace:: OEChem


.. meta::
   :keywords: OESimpleAppOptions, SimpleAppOptions


.. _OEChem_OESimpleAppOptions:

.. oe:class:: OESimpleAppOptions

   .. oe:api::

      class OESimpleAppOptions : public OESystem::OEOptions

   The :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` represents a simple options class,
   representing a simple applications interface with an input reader file and
   an output writer file.

   .. seealso::

      * :ref:`OEOptions <OESystem_OEOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_simple_omega` example
      * :ref:`section_examples_dens_omega` example
      * :ref:`section_examples_stereo_and_torsion` example
      * :ref:`section_examples_torsion` example
      * :ref:`section_examples_fraglib` example
      * :ref:`section_examples_macrocycles` example

   The :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` class defines the following public methods:
    * :oe:meth:`GetInFile<OEChem::OESimpleAppOptions::GetInFile>` and
      :oe:meth:`SetInFile<OEChem::OESimpleAppOptions::SetInFile>`
    * :oe:meth:`GetOutFile<OEChem::OESimpleAppOptions::GetOutFile>` and
      :oe:meth:`SetOutFile<OEChem::OESimpleAppOptions::SetOutFile>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OESimpleAppOptions(const std::string& name,
                               const unsigned inFileType,
                               const unsigned outFileType)
            OESimpleAppOptions(const std::string& name,
                               const std::string& inFileExt,
                               const unsigned outFileType)
            OESimpleAppOptions(const std::string& name,
                               const unsigned inFileType,
                               const std::string& outFileExt)
            OESimpleAppOptions(const std::string& name,
                               const std::string& inFileExt,
                               const std::string& outFileExt)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const unsigned inFileType,
                               const unsigned outFileType)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const std::string& inFileExt,
                               const unsigned outFileType)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const unsigned inFileType,
                               const std::string& outFileExt)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const std::string& inFileExt,
                               const std::string& outFileExt)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const unsigned inFileType)
            OESimpleAppOptions(const OESystem::OEOptions& opts,
                               const std::string& name,
                               const std::string& inFileExt)
            OESimpleAppOptions(const OESimpleAppOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESimpleAppOptions(opts: OEOptions, name: str, inFileType: int,
                               outFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileExt: str,
                               outFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileType: int,
                               outFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileExt: str,
                               outFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(name: str, inFileType: int, outFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(name: str, inFileExt: str, outFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(name: str, inFileType: int, outFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(name: str, inFileExt: str, outFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileType: int) -> OESimpleAppOptions
            OESimpleAppOptions(opts: OEOptions, name: str, inFileExt: str) -> OESimpleAppOptions
            OESimpleAppOptions(arg2: OESimpleAppOptions) -> OESimpleAppOptions

      Default and copy constructors.

      The ``opts`` represents the sub-options that should be wrapped to extend this options to generate
      the API for the intended application, where applicable, and the ``name`` represents the name of the application.
      The ``inFileType`` and ``outFileType`` refers to the input and output file types. The file types
      can be specified using constants as defined in the :oe:constns:`OEChem::OEFileStringType` namespace,
      or using a string value. Variation of constructors that does not require an output file can
      be used when an output is not desired in an application.

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

      .. oe:api::

         OESimpleAppOptions &operator=(const OESimpleAppOptions &)

      Assignment operator.
   
   .. oe:method:: GetInFile

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

         .. oe:api::

            std::string GetInFile() const

      .. oe:language:: python

         .. oe:api:: python

            GetInFile() -> str

      See :oe:meth:`SetInFile<OEChem::OESimpleAppOptions::SetInFile>` method.

   .. oe:method:: GetOutFile

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

         .. oe:api::

            std::string GetOutFile() const

      .. oe:language:: python

         .. oe:api:: python

            GetOutFile() -> str

      See :oe:meth:`SetOutFile<OEChem::OESimpleAppOptions::SetOutFile>` method.

   .. oe:method:: SetInFile

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

         .. oe:api::

            bool SetInFile(const std::string value)

      .. oe:language:: python

         .. oe:api:: python

            SetInFile(value: str) -> bool

      Sets name of the input file for the application. **Default: None**

   .. oe:method:: SetOutFile

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

         .. oe:api::

            bool SetOutFile(const std::string value)

      .. oe:language:: python

         .. oe:api:: python

            SetOutFile(value: str) -> bool

      Sets name of the output file for the application. **Default: None**
