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

.. oe:namespace:: OEFF



.. meta::
   :keywords: OEMMFFIEFFOptions, MMFFIEFFOptions


.. _OEFF_OEMMFFIEFFOptions:

.. oe:class:: OEMMFFIEFFOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEMMFFIEFFOptions : public OESystem::OEOptions

   This class orovides interface to setup options required for :ref:`OEMMFFIEFF <OEFF_OEMMFFIEFF>`
   initialization.
   
   The :ref:`OEMMFFIEFFOptions <OEFF_OEMMFFIEFFOptions>` class defines the following public methods:
    * :oe:meth:`GetIEFFTerms<OEFF::OEMMFFIEFFOptions::GetIEFFTerms>`
    * :oe:meth:`GetMMFFTerms<OEFF::OEMMFFIEFFOptions::GetMMFFTerms>`
    * :oe:meth:`GetUseMMFF94s<OEFF::OEMMFFIEFFOptions::GetUseMMFF94s>`
    * :oe:meth:`SetIEFFTerms<OEFF::OEMMFFIEFFOptions::SetIEFFTerms>`
    * :oe:meth:`SetMMFFTerms<OEFF::OEMMFFIEFFOptions::SetMMFFTerms>`
    * :oe:meth:`SetUseMMFF94s<OEFF::OEMMFFIEFFOptions::SetUseMMFF94s>`
   
   
   .. oe:method:: Constructors

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

         .. oe:api::

            OEMMFFIEFFOptions()
            OEMMFFIEFFOptions(const OEMMFFIEFFOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFIEFFOptions() -> OEMMFFIEFFOptions
            OEMMFFIEFFOptions(arg2: OEMMFFIEFFOptions) -> OEMMFFIEFFOptions

      Default and copy constructors.

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

      .. oe:api::

         OEMMFFIEFFOptions &operator=(const OEMMFFIEFFOptions&)

      Assignment operator.


   .. oe:method:: GetIEFFTerms

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

         .. oe:api::

            unsigned int GetIEFFTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetIEFFTerms() -> int

      Gets the constant defining what terms of the IEFF force field to be used.

   .. oe:method:: GetMMFFTerms

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

         .. oe:api::

            unsigned int GetMMFFTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFTerms() -> int

      Gets the constant defining what terms of the MMFF force field to be used.

   .. oe:method:: GetUseMMFF94s

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

         .. oe:api::

            bool GetUseMMFF94s() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseMMFF94s() -> bool

      Gets flag that defines if MMFF94s variation of parameters should be used.

   .. oe:method:: SetIEFFTerms

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

         .. oe:api::

            bool SetIEFFTerms(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetIEFFTerms(value: int) -> bool

      Sets the constant defining what terms of the IEFF force field to be used.

   .. oe:method:: SetMMFFTerms

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

         .. oe:api::

            bool SetMMFFTerms(const unsigned int)

      .. oe:language:: python

         .. oe:api:: python

            SetMMFFTerms(value: int) -> bool

      Sets the constant defining what terms of the MMFF force field to be used.

   .. oe:method:: SetUseMMFF94s

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

         .. oe:api::

            void SetUseMMFF94s(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseMMFF94s(value: bool) -> bool

      Sets flag that defines if MMFF94s variation of parameters should be used.

