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

.. oe:namespace:: OEProton

.. meta::
   :keywords: OEELFOptions, ELFOptions


.. _OEProton_OEELFOptions:

.. oe:class:: OEELFOptions

   .. oe:api::

      class OEELFOptions : public OESystem::OEOptions

   This class provides an interface to setup options required for 
   :ref:`OEELF <OEProton_OEELF>` calculations.
   
   The :ref:`OEELFOptions <OEProton_OEELFOptions>` class defines the following public methods:
    * :oe:meth:`GetElfLimit<OEProton::OEELFOptions::GetElfLimit>` and 
      :oe:meth:`SetElfLimit<OEProton::OEELFOptions::SetElfLimit>`
    * :oe:meth:`GetPercent<OEProton::OEELFOptions::GetPercent>` and
      :oe:meth:`SetPercent<OEProton::OEELFOptions::SetPercent>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEELFOptions()
            OEELFOptions(const OEELFOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEELFOptions() -> OEELFOptions
            OEELFOptions(arg2: OEELFOptions) -> OEELFOptions

      Default and copy constructors.

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

      .. oe:api::

         OEELFOptions &operator=(const OEELFOptions &)

      Assignment operator.


   .. oe:method:: GetElfLimit

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

         .. oe:api::

            unsigned GetElfLimit() const

      .. oe:language:: python

         .. oe:api:: python

            GetElfLimit() -> int

      See :oe:meth:`SetElfLimit<OEProton::OEELFOptions::SetElfLimit>` method.

   .. oe:method:: GetPercent

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

         .. oe:api::

            double GetPercent() const

      .. oe:language:: python

         .. oe:api:: python

            GetPercent() -> float

      See :oe:meth:`SetPercent<OEProton::OEELFOptions::SetPercent>` method.

   .. oe:method:: SetElfLimit

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

         .. oe:api::

            bool SetElfLimit(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetElfLimit(value: int) -> bool

      Sets the **number of diverse conformers to select** from the
      least interacting conformers set.
      **Default: 10**

   .. oe:method:: SetPercent

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

         .. oe:api::

            bool SetPercent(const double)

      .. oe:language:: python

         .. oe:api:: python

            SetPercent(value: float) -> bool

      Sets the **percentage of input conformers to select** as the
      electrostatically least-interacting set.
      **Default: 2.0**
