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

.. oe:namespace:: OESpruce

.. _OESpruce_OESidechainBuilderOptions:

.. oe:class:: OESidechainBuilderOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::

      class OESidechainBuilderOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for building sidechains in the :oe:func:`OESpruce::OEBuildSidechains`,
   :oe:func:`OESpruce::OEMutateResidue`, :oe:func:`OESpruce::OEMutateResidues`, :oe:func:`OESpruce::OEBuildLoops`,
   :oe:func:`OESpruce::OEBuildSingleLoop` functions.

   .. oe:method:: Constructors

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

         .. oe:api::

            OESidechainBuilderOptions()
            OESidechainBuilderOptions(const OESidechainBuilderOptions &)
            OESidechainBuilderOptions(bool minimizeSidechainsShell)

      .. oe:language:: python

         .. oe:api:: python

            OESidechainBuilderOptions() -> OESidechainBuilderOptions
            OESidechainBuilderOptions(arg2: OESidechainBuilderOptions) -> OESidechainBuilderOptions
            OESidechainBuilderOptions(minimizeSidechainsShell: bool) -> OESidechainBuilderOptions

      Default, copy, and parameterized constructors for the `OESidechainBuilderOptions` object.

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

      .. oe:api::

         OESidechainBuilderOptions &operator=(const OESidechainBuilderOptions &)

      Assignment operator.

   .. _OESpruce_OESidechainBuilderOptions_GetDeleteClashingSolvent:

   .. oe:method:: GetDeleteClashingSolvent

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

         .. oe:api::

            bool GetDeleteClashingSolvent() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteClashingSolvent() -> bool

      Returns the boolean whether or not to delete solvent waters that clash with other atoms.
   
   .. _OESpruce_OESidechainBuilderOptions_GetMaxClusterSize:

   .. oe:method:: GetMaxClusterSize

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

         .. oe:api::

            unsigned GetMaxClusterSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxClusterSize() -> int

      Returns the maximum number of partial residues allowed in a cluster. Clusters are made based on proximity of partial residues to each other.

   .. _OESpruce_OESidechainBuilderOptions_GetMinimizeSidechains:

   .. oe:method:: GetMinimizeSidechains

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

         .. oe:api::

            bool GetMinimizeSidechains() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinimizeSidechains() -> bool

      Returns the boolean whether or not to minimize the sidechains of the target residues.

   .. _OESpruce_OESidechainBuilderOptions_GetMinimizeSidechainsShell:

   .. oe:method:: GetMinimizeSidechainsShell

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

         .. oe:api::

            bool GetMinimizeSidechainsShell() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinimizeSidechainsShell() -> bool

      Returns the boolean whether or not to minimize the sidechains of the residues around the target residues.


   .. _OESpruce_OESidechainBuilderOptions_GetRotamerLibrary:

   .. oe:method:: GetRotamerLibrary

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

         .. oe:api::

            unsigned GetRotamerLibrary() const

      .. oe:language:: python

         .. oe:api:: python

            GetRotamerLibrary() -> int

      Returns the rotamer library used for side chain rebuilding.

   .. _OESpruce_OESidechainBuilderOptions_GetStrictMode:

   .. oe:method:: GetStrictMode

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

         .. oe:api::

            bool GetStrictMode() const

      .. oe:language:: python

         .. oe:api:: python

            GetStrictMode() -> bool

      Returns the boolean whether or not to fail early if any of the partial or missings sidechain could not be built
   

   .. _OESpruce_OESidechainBuilderOptions_SetRotamerCoverage:


   .. oe:method:: SetRotamerCoverage

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

         .. oe:api::

            bool SetRotamerCoverage(double rotamerCoverage)

      .. oe:language:: python

         .. oe:api:: python

            SetRotamerCoverage(value: float) -> bool

      Sets the value for the rotamer coverage percentage to be used for side chain rebuilding.

   .. _OESpruce_OESidechainBuilderOptions_SetRotamerLibrary:

   .. oe:method:: SetRotamerLibrary

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

         .. oe:api::

            bool SetRotamerLibrary(unsigned rotamerLibrary)

      .. oe:language:: python

         .. oe:api:: python

            SetRotamerLibrary(value: int) -> bool

      Sets the boolean of the rotamer library.

   .. _OESpruce_OESidechainBuilderOptions_SetDeleteClashingSolvent:

   .. oe:method:: SetDeleteClashingSolvent

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

         .. oe:api::

            bool SetDeleteClashingSolvent(bool deleteClashingSolvent)

      .. oe:language:: python

         .. oe:api:: python

            SetDeleteClashingSolvent(value: bool) -> bool

      Sets the boolean of whether or not to delete solvent waters that clash with other atoms.
   
   .. _OESpruce_OESidechainBuilderOptions_SetMaxClusterSize:

   .. oe:method:: SetMaxClusterSize

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

         .. oe:api::

            bool SetMaxClusterSize(unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxClusterSize(value: int) -> bool

      Sets the maximum number of partial residues allowed in a cluster. Clusters are made based on proximity of partial residues to each other.

   .. _OESpruce_OESidechainBuilderOptions_SetMinimizeSidechains:

   .. oe:method:: SetMinimizeSidechains

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

         .. oe:api::

            bool SetMinimizeSidechains(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetMinimizeSidechains(value: bool) -> bool

      Sets the boolean whether or not to minimize the sidechains of the target residues.

   .. _OESpruce_OESidechainBuilderOptions_SetMinimizeSidechainsShell:


   .. oe:method:: SetMinimizeSidechainsShell

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

         .. oe:api::

            bool SetMinimizeSidechainsShell(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetMinimizeSidechainsShell(value: bool) -> bool

      Sets the boolean whether or not to minimize the sidechains of the residues around the target residues.

   .. _OESpruce_OESidechainBuilderOptions_SetStrictMode:

   .. oe:method:: SetStrictMode

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

         .. oe:api::

            bool SetStrictMode(bool)

      .. oe:language:: python

         .. oe:api:: python

            SetStrictMode(value: bool) -> bool

      Sets the boolean whether or not to fail early if any of the partial or missings sidechain could not be built
   

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitBuildOptions <OESpruce_OEDesignUnitBuildOptions>` class
      * :oe:func:`OESpruce::OEBuildSidechains` function
      * :oe:func:`OESpruce::OEMutateResidue` function
      * :oe:func:`OESpruce::OEMutateResidues` function
      * :oe:func:`OESpruce::OEBuildLoops` function
      * :oe:func:`OESpruce::OEBuildSingleLoop` function
