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

.. oe:namespace:: OESpruce



.. _OESpruce_OEDesignUnitMutationOptions:

.. oe:class:: OEDesignUnitMutationOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEDesignUnitMutationOptions : public OESystem::OEOptions

   This class stores the optional parameter sets used in design unit mutation for use in the :oe:func:`OESpruce::OEMutateResidues` function.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEDesignUnitMutationOptions()
            OEDesignUnitMutationOptions(const OEDesignUnitMutationOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitMutationOptions() -> OEDesignUnitMutationOptions
            OEDesignUnitMutationOptions(arg2: OEDesignUnitMutationOptions) -> OEDesignUnitMutationOptions

      Default and copy constructors.

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

      .. oe:api::

         OEDesignUnitMutationOptions &operator=(const OEDesignUnitMutationOptions &)

      Assignment operator.

   .. oe:method:: AddMutation

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

         .. oe:api::

            void AddMutation(const OEChem::OEResidue mutationRes,
                             const unsigned targetIdx)

      .. oe:language:: python

         .. oe:api:: python

            AddMutation(mutationRes: OEResidue, targetIdx: int) -> None

      Adds a mutation to make based on an input :ref:`OEResidue <OEChem_OEResidue>` object, along with a constant representing the target component which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. oe:method:: ClearMutations

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

         .. oe:api::

            void ClearMutations()

      .. oe:language:: python

         .. oe:api:: python

            ClearMutations() -> None

      Clears all mutations.

   .. oe:method:: GetMutations

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

         .. oe:api::

            std::map<OEChem::OEResidue, unsigned> GetMutations() const

      .. oe:language:: python

         .. oe:api:: python

            GetMutations() -> mapOEResidueUnsigned

      Returns the stored `std::map` of mutations, which is keyed on an :ref:`OEResidue <OEChem_OEResidue>` object with a value of the target component which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. oe:method:: SetMutations

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

         .. oe:api::

            void SetMutations(const std::map<OEChem::OEResidue, unsigned>& mutations)

      .. oe:language:: python

         .. oe:api:: python

            SetMutations(mutations: mapOEResidueUnsigned) -> None

      Sets the stored `std::map` of mutations, which is keyed on an :ref:`OEResidue <OEChem_OEResidue>` object with a value of the target component which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. seealso::

      * :ref:`OESidechainBuilderOptions <OESpruce_OESidechainBuilderOptions>` class
