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

.. oe:namespace:: OEFF



.. meta::
   :keywords: OEMMFFAmberOptions, MMFFAmberOptions


.. _OEFF_OEMMFFAmberOptions:

.. oe:class:: OEMMFFAmberOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OEMMFFAmberOptions : public OESystem::OEOptions

   Encapsulates the options that control the initialization of
   :ref:`OEMMFFAmber <OEFF_OEMMFFAmber>`.

   .. seealso::

      * :ref:`OEMMFFAmber <OEFF_OEMMFFAmber>` class

   The :ref:`OEMMFFAmberOptions <OEFF_OEMMFFAmberOptions>` class defines the following public methods:
    * :oe:meth:`GetAmberTerms<OEFF::OEMMFFAmberOptions::GetAmberTerms>`
    * :oe:meth:`GetIntermolecularVdWCutoff<OEFF::OEMMFFAmberOptions::GetIntermolecularVdWCutoff>`
    * :oe:meth:`GetMMFFTerms<OEFF::OEMMFFAmberOptions::GetMMFFTerms>`
    * :oe:meth:`GetUseExternalCharges<OEFF::OEMMFFAmberOptions::GetUseExternalCharges>`
    * :oe:meth:`GetUseMMFF94s<OEFF::OEMMFFAmberOptions::GetUseMMFF94s>`
    * :oe:meth:`SetAmberTerms<OEFF::OEMMFFAmberOptions::SetAmberTerms>`
    * :oe:meth:`SetIntermolecularVdWCutoff<OEFF::OEMMFFAmberOptions::SetIntermolecularVdWCutoff>`
    * :oe:meth:`SetMMFFTerms<OEFF::OEMMFFAmberOptions::SetMMFFTerms>`
    * :oe:meth:`SetUseExternalCharges<OEFF::OEMMFFAmberOptions::SetUseExternalCharges>`
    * :oe:meth:`SetUseMMFF94s<OEFF::OEMMFFAmberOptions::SetUseMMFF94s>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEMMFFAmberOptions()
            OEMMFFAmberOptions(const OEMMFFAmberOptions&)

      .. oe:language:: python

         .. oe:api:: python

            OEMMFFAmberOptions() -> OEMMFFAmberOptions
            OEMMFFAmberOptions(arg2: OEMMFFAmberOptions) -> OEMMFFAmberOptions

      Default and copy constructors.

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

      .. oe:api::

         OEMMFFAmberOptions &operator=(const OEMMFFAmberOptions&)

      Assignment operator.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEMMFFAmberOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMMFFAmberOptions

      Returns a pointer to a copy of the options object.

   .. oe:method:: GetAmberTerms

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

         .. oe:api::

            unsigned GetAmberTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetAmberTerms() -> int

      Gets the constant defining which Amber force field terms to include.

   .. oe:method:: GetIntermolecularVdWCutoff

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

         .. oe:api::

            double GetIntermolecularVdWCutoff() const

      .. oe:language:: python

         .. oe:api:: python

            GetIntermolecularVdWCutoff() -> float

      Gets the cutoff distance (in Angstroms) used for intermolecular
      van der Waals interactions.

   .. oe:method:: GetMMFFTerms

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

         .. oe:api::

            unsigned GetMMFFTerms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMMFFTerms() -> int

      Gets the constant defining which MMFF force field terms to include.

   .. oe:method:: GetUseExternalCharges

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

         .. oe:api::

            bool GetUseExternalCharges() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseExternalCharges() -> bool

      Gets the flag that controls whether partial charges already present
      on the molecule are used instead of MMFF-derived charges.

   .. oe:method:: GetUseMMFF94s

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

         .. oe:api::

            bool GetUseMMFF94s() const

      .. oe:language:: python

         .. oe:api:: python

            GetUseMMFF94s() -> bool

      Gets the flag that controls whether the MMFF94s variant of parameters
      is used.

   .. oe:method:: SetAmberTerms

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

         .. oe:api::

            bool SetAmberTerms(unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetAmberTerms(value: int) -> bool

      Sets the constant defining which Amber force field terms to include.

   .. oe:method:: SetIntermolecularVdWCutoff

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

         .. oe:api::

            void SetIntermolecularVdWCutoff(double)

      .. oe:language:: python

         .. oe:api:: python

            SetIntermolecularVdWCutoff(value: float) -> bool

      Sets the cutoff distance (in Angstroms) used for intermolecular
      van der Waals interactions.

   .. oe:method:: SetMMFFTerms

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

         .. oe:api::

            bool SetMMFFTerms(unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMMFFTerms(value: int) -> bool

      Sets the constant defining which MMFF force field terms to include.

   .. oe:method:: SetUseExternalCharges

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

         .. oe:api::

            void SetUseExternalCharges(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseExternalCharges(value: bool) -> bool

      Sets the flag that controls whether partial charges already present
      on the molecule are used instead of MMFF-derived charges.

   .. oe:method:: SetUseMMFF94s

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

         .. oe:api::

            void SetUseMMFF94s(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetUseMMFF94s(value: bool) -> bool

      Sets the flag that controls whether the MMFF94s variant of parameters
      is used.
