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

.. oe:namespace:: OEChem


.. meta::
   :keywords: OERefInputAppOptions, RefInputAppOptions


.. _OEChem_OERefInputAppOptions:

.. oe:class:: OERefInputAppOptions

   .. oe:api::

      class OERefInputAppOptions : public OESystem::OEOptions

   The :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>` represents an options class,
   representing an applications interface that requires an additional reference or target input, 
   along with an input reader and an output writer file.

   .. seealso::

      * :ref:`OEOptions <OESystem_OEOptions>` class

   .. admonition:: Code Examples

      * :ref:`section_examples_docking` example
      * :ref:`section_examples_posing` example

   The :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>` class defines the following public methods:
    * :oe:meth:`GetInFile<OEChem::OERefInputAppOptions::GetInFile>` and
      :oe:meth:`SetInFile<OEChem::OERefInputAppOptions::SetInFile>`
    * :oe:meth:`GetOutFile<OEChem::OERefInputAppOptions::GetOutFile>` and
      :oe:meth:`SetOutFile<OEChem::OERefInputAppOptions::SetOutFile>`
    * :oe:meth:`GetRefFile<OEChem::OERefInputAppOptions::GetRefFile>` and
      :oe:meth:`SetRefFile<OEChem::OERefInputAppOptions::SetRefFile>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OERefInputAppOptions(const OESystem::OEOptions& opts,
                                 const std::string& name,
                                 const unsigned inFileType,
                                 const unsigned outFileType,
                                 const unsigned refFileType,
                                 const std::string& refCmdName)
            OERefInputAppOptions(const OESystem::OEOptions& opts,
                                 const std::string& name,
                                 const unsigned inFileType,
                                 const unsigned outFileType,
                                 const std::string& refFileExt,
                                 const std::string& refCmdName)
            OERefInputAppOptions(const OESystem::OEOptions& opts,
                                 const std::string& name,
                                 const unsigned inFileType,
                                 const unsigned refFileType,
                                 const std::string& refCmdName)
            OERefInputAppOptions(const OESystem::OEOptions& opts,
                                 const std::string& name,
                                 const unsigned inFileType,
                                 const std::string& refFileExt,
                                 const std::string& refCmdName)
            OERefInputAppOptions(const OERefInputAppOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                                 outFileType: int, refFileType: int,
                                 refCmdName: str) -> OERefInputAppOptions
            OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                                 outFileType: int, refFileExt: str,
                                 refCmdName: str) -> OERefInputAppOptions
            OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                                 refFileType: int, refCmdName: str) -> OERefInputAppOptions
            OERefInputAppOptions(opts: OEOptions, name: str, inFileType: int,
                                 refFileExt: str, refCmdName: str) -> OERefInputAppOptions
            OERefInputAppOptions(arg2: OERefInputAppOptions) -> OERefInputAppOptions

      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, the ``name`` represents the name of the application, and the
      ``refCmdName`` represents the command line flag for reference input. The ``inFileType``, ``outFileType``, 
      and ``refFileType`` refers to if the input, output and the reference input file types as defined in the
      :oe:constns:`OEChem::OEFileStringType` namespace. The second overload accepts the reference input file 
      type as a string. 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::

         OERefInputAppOptions &operator=(const OERefInputAppOptions &)

      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::OERefInputAppOptions::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::OERefInputAppOptions::SetOutFile>` method.

   .. oe:method:: GetRefFile

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

         .. oe:api::

            std::string GetRefFile() const

      .. oe:language:: python

         .. oe:api:: python

            GetRefFile() -> str

      See :oe:meth:`SetRefFile<OEChem::OERefInputAppOptions::SetRefFile>` method.

   .. oe:method:: SetInFile

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

         .. oe:api::

            bool SetInFile(string)

      .. 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(string)

      .. oe:language:: python

         .. oe:api:: python

            SetOutFile(value: str) -> bool

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

   .. oe:method:: SetRefFile

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

         .. oe:api::

            bool SetRefFile(string)

      .. oe:language:: python

         .. oe:api:: python

            SetRefFile(value: str) -> bool

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